Skip to content

Commit 5f81f89

Browse files
committed
Added API credential configuration links.
1 parent 20cf1ff commit 5f81f89

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

readme.markdown

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ If you encounter issues, get as far as you can, and we will work through them in
6969

7070
There are two alternative approaches (choose one):
7171

72-
1. Use cloud-hosted Codespaces on Github. This is the easiest option, and the Github free account tier has more than enough time for the course.
72+
1. Use cloud-hosted Codespaces on Github (recommended). This is the easiest option, and the Github free account tier has more than enough time for the course.
7373
1. Install VS Code and Docker on your computer. This is also relatively easy and free.
7474

7575

76-
### Github Codespaces
76+
### Github Codespaces (recommended)
7777

7878
1. Go to <https://github.com>.
7979
1. Sign in with your Github account (or create one).
@@ -117,6 +117,23 @@ Once your local container has been created, you can return to it using the follo
117117
1. On the Welcome tab, under the heading "Recent," click the "carma_python in a unique volume" link.
118118

119119

120+
## API configuration
121+
122+
**Note:** I will refer to the configuration instructions below during the course, but you do not need to follow these when preparing for the course.
123+
124+
Later in the course, we will register for free API credentials.
125+
To follow best security practices with API keys and passwords, there is some configuration we need to do.
126+
It also makes using these credentials very convenient.
127+
128+
There are different processes depending on where we are running code.
129+
130+
1. Github Codespaces (recommended). [Github: Adding secrets for a repository](https://docs.github.com/en/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization#adding-secrets-for-a-repository)
131+
1. Mac, Windows, and Linux. [OpenAI: Best Practices for API Key Safety](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)
132+
- Follow the relevant instructions for your platform in point 4.
133+
- We are using this as a general reference, so our environment variable names will be different from the one described here.
134+
- For Windows, I suggest using option 2.
135+
136+
120137
## About Jason
121138

122139
Jason T. Kiley is an Assistant Professor at Clemson University.

0 commit comments

Comments
 (0)