Skip to main content

Retrieve settings and secrets from different storages.

Project description

configstore is a small pluggable library that lets you retrieve settings or secrets from a variety of storage systems to configure your app.

The main pain point this tries to solve is:

Assume you have your config in environment variables but you want to store your secrets in something else. How do you mix having a secret backend for your secrets but still keep everything else in environment variables? With this module you can use both. Let’s say you use DATABASE_PASSWORD as your database password env variable. This will first try to find this in your first backend (let’s say docker secrets) and if it fails will fall back on the env variable.

See example.py for some example code.

Available backends

configstore.EnvVarBackend finds settings in environment variables. This is the classic 12-factor approach, which main drawback is that it’s easy for outside tools or sub-processes to inspect the environment and access sensitive data. This backend is still useful for settings that are not secrets.

configstore.DotenvBackend lets you put settings in a key-value format file, using the dotenv module, which is useful for local development. This backend requires an optional dependency, so use a requirement like configstore[dotenv] to get everything installed.

configstore.DockerSecretBackend can read Docker secrets. This is a secure storage with first-class support in the Docker runtime and related tooling.

configstore.AwsSsmBackend connects to the Parameter Store service that is part of AWS Systems Manager. This backend requires optional dependencies (boto3), so use a requirement like configstore[awsssm] to get everything installed.

Contributors

Original author: Antoine Reversat @crevetor

Current maintainer: Éric Araujo @merwok

Project sponsored by Caravan Coop @caravancoop

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

configstore-0.5.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

configstore-0.5-py2.py3-none-any.whl (8.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file configstore-0.5.tar.gz.

File metadata

  • Download URL: configstore-0.5.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.6

File hashes

Hashes for configstore-0.5.tar.gz
Algorithm Hash digest
SHA256 58dc7479ab3c4ee4e2e899fdb83a7b6a60212bdead7bf10051a840cd867e37e2
MD5 eb19349af8e6c22fef1e827626419db9
BLAKE2b-256 aed263af919dd89557f00d8390f50a74cb109a6aa06c1c2bdb778b28eb2f7e80

See more details on using hashes here.

File details

Details for the file configstore-0.5-py2.py3-none-any.whl.

File metadata

  • Download URL: configstore-0.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.6

File hashes

Hashes for configstore-0.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 646e39f8b07f68a41ed2105813b254792f1e88e7b831c8d012007ee3dd1cc03e
MD5 e8453ad289fbdcee75f9956eb5076533
BLAKE2b-256 f5dc766224574ad3152ee3e80e4b20e6d85e636ba9e1e21e785c066dc56dd97d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page