Skip to content

Commit 94a479e

Browse files
committed
Add setup documentation for .env file in README
- Update README.md with related documentation
1 parent c130498 commit 94a479e

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,25 @@ modules:
4242
```
4343
brew install pipenv
4444
```
45+
### Running Scripts that Require Client Credentials
46+
To successfully run scripts that require client credentials, you will need to follow these steps:
47+
1. Create a `.env` file at the root of the repository by running the following command in your terminal:
48+
```
49+
touch .env
50+
```
51+
2. Copy the contents of the `example.env` file in the script's directory to `.env`:
52+
```
53+
cp path/to/script/example.env .env
54+
```
55+
3. Uncomment the variables in the `.env` file and assign values as needed. See [source.md](sources.md) on how to get credentials:
56+
```
57+
API_KEYS=your_api_key
58+
PSE_KEY=your_pse_key
59+
```
60+
4. Save the changes to the .env file.
61+
62+
5. You should now be able to run scripts that require client credentials without any issues.
63+
4564
4665
[pipenvdocs]: https://pipenv.pypa.io/en/latest/
4766
[homebrew]: https://brew.sh/

0 commit comments

Comments
 (0)