File tree Expand file tree Collapse file tree 1 file changed +18
-5
lines changed
Expand file tree Collapse file tree 1 file changed +18
-5
lines changed Original file line number Diff line number Diff line change @@ -105,10 +105,9 @@ modules:
105105[homebrew]: https://brew.sh/
106106
107107
108- # ## Running scripts that require client credentials
108+ # ## Managing client credentials
109109
110- To successfully run scripts that require client credentials, you will need to
111- follow these steps:
110+ Client credentials should be stored in an environment file:
1121111. Copy the contents of the ` env.example` file in the script' s directory to
113112 `.env`:
114113 ```shell
@@ -121,8 +120,22 @@ follow these steps:
121120 GCS_CX = your_pse_id
122121 ```
1231223. Save the changes to the `.env` file.
124- 4. You should now be able to run scripts that require client credentials
125- without any issues.
123+
124+ You should now be able to run scripts that require client credentials without
125+ any issues. The `.env` file is ignored by git to help ensure sensitive data is
126+ not distributed.
127+
128+
129+ ### Running the scripts
130+
131+ All of the scripts should be run from the root of the repository using pipenv. For example:
132+ ```bash
133+ pipenv run ./scripts/1-fetch/github_fetch.py -h
134+ ```
135+
136+ When run this way, the shared library (`scripts/shared.py`) provides easy access
137+ to all of the necessary paths and all of the modules managed by pipenv are
138+ available.
126139
127140
128141### Static analysis
You can’t perform that action at this time.
0 commit comments