Best Practices Python - Where to store API KEYS/TOKENS

Question

I am building a system that uses API tokens and keys to access services, but where is the best place to store them? I want to push the code to GitHub without pushing the tokens.

Currently, I've placed them in a blank file named Constants.py and, in the main python file, I import Constants.py.

API_KEY_SERVICE = "ABC123ABC"

Main.py:

import Constants
service_key = Constants.API_KEY_SENDGRID

One option is read these constants from environment variables. That way you won't have any secrets in your source code. — Andrej Kesely, Jul 11 '19 at 18:32
As a first shot you should add the file to `.gitignore` to prevent accidental commits and pushes. — Klaus D., Jul 11 '19 at 18:32
Another is using a yaml file and adding the .yaml to `.gitignore`. — Niloct, Jul 11 '19 at 18:33

score 18 · Accepted Answer · answered Jul 11 '19 at 18:35

What you are attempting is the correct way to segregate sensitive information from code. You should include the constants.py in your .gitignore file which will prevent git from tracking that file and thus not pushing it to github.

For .gitignore, refer: https://git-scm.com/docs/gitignore

hrokr · Answer 2 · 2022-08-31T17:17:37.437

13

There are a few options:

Store it locally as you have and, as Sebastin Santy noted, add constants.py to your .gitignore file.
Store it as an environment variable if you're using a conda virtual environment. Virtual environments aren't stored; the requirements for creating one are in the requirements.txt file. You can find more on the steps from the conda documetation
Use the OS module
If you have more than one set of environment variables, you might consider using decouple
If you're using AWS, you'll want to store the (what would be third party) keys in their own area with its own IAM. There are two ways recommended by AWS.

a. IAM roles
b. Store Secrets using Parameter Store
c. Store Secrets using Secrets Manager - Current method recommended by AWS

edited Aug 31 '22 at 17:17

answered Jul 06 '21 at 03:05

hrokr

3,276
3
21
39

3

I like that you included AWS in your answer but im curious why you didnt mention AWS Secrets Manager? – BilliD Nov 25 '21 at 20:17
2

@BilliD - No, you're right. That was an oversight. Thanks for pointing it out. – hrokr Aug 31 '22 at 17:18

score 3 · Answer 3 · answered Sep 13 '22 at 01:13

There are some good answers here. To add to them, I think we can also use the keyring module, which will read the credentials from Windows credentials or Mac OS keychain. But I would love to hear the thoughts of the community. Thanks.

here's the link to that - https://pypi.org/project/keyring/

Best Practices Python - Where to store API KEYS/TOKENS

3 Answers3

Linked