A small package to easily read API keys from env files
Project description
read-env
Boilerplate code to read API keys from a .env file in Python
Quickstart
Functions to choose from include
read_pair_from_env
: Read key pair from specified env fileread_key_from_env
: Read API key from specified env fileread_sec_from_env
: Read API secret from specified env file
You can install the read-env-keys
package via pip
pip3 install read-env-keys
After installing, you will be able to import the module using
from read_env_keys import *
or
import read_env_keys
Read an API key from your .env file
After you have installed the package, create an env file (if you do not have one already) in your current working directory (cwd).
-
MacOS / Unix
Get the current working directory's absolute path by typing
pwd
in the terminal. Copy and paste this as a string with the name of your env file appended (including the
.env
extension) as an argument. -
Windows
Get the current working directory's absolute path by typing
cd
in the command line.
Once you have the full path to the env file, pass it as an argument. You can optionally specifiy the API key name to read.
from read_env_keys import *
# Read an API Key. Default key name is 'API_KEY'
api_key_value = read_key_from_env(YOUR_ENVS_ABSOLUTE_FILEPATH)
# Read an API Key and specify the key name in the env file
api_key_value = read_key_from_env(YOUR_ENVS_ABSOLUTE_FILEPATH, api_key='my_key')
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for read_env_keys-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3da3324d944abad4812144dbf2383c3f3dd07b7c7516723b55173102aaf85350 |
|
MD5 | 9e0592d119e09209c05be9332744f3f6 |
|
BLAKE2b-256 | 58b8434e96856e7c639d1c6d7c24aa822436387e0edad20f8e220595df5976aa |