Where to store my API key in an open source Python Script

Question

So I'm working on with an api from IsThereAnyDeals and I'm wondering where I should store my API key? Is it possible to store it remotely or is it fine to just store it inside the script?

Neither. Store it outside the script and have the script read from the file(which isn't stored in any repository). — ewokx, Nov 23 '20 at 09:08
You only need to store it remotely (securely on the host server) if you’re going to deploy it somewhere. Otherwise keep it a “secret” (local file). — JBallin, Nov 23 '20 at 09:16

score 3 · Accepted Answer · answered Nov 23 '20 at 09:14

3

ConfigParser is a good choice to setup your configuration-files in Python.

Something like this:

import configparser

cfg = configparser.ConfigParser()
cfg.read('example.cfg')

print(cfg.get('KEYS', 'api_key', raw=''))

example.cfg:

[KEYS]
api_key: @#$@GSSAS

answered Nov 23 '20 at 09:14

Serial Lazer

1,667
1
7
15

My API key will still be exposed. It that okay? – Dave Cordero Nov 23 '20 at 09:35
2

Of course you shouldnt be uploading the `example.cfg`! Thats only for your instance – Serial Lazer Nov 23 '20 at 09:36

score 1 · Answer 2 · answered Apr 08 '21 at 15:08

1

You can add your cfg file to .gitignore, so that this file doesn't get uploaded, when you do a git commit.

You can read more about that topic here: How to ignore certain files in Git

answered Apr 08 '21 at 15:08

MajaOlsz

11
3

Where to store my API key in an open source Python Script

2 Answers2