Skip to main content

Argparse wrapper that supports fallback settings in env vars and/or a yaml file.

Project description

appsettings

Sometimes you want to read a setting from the command line. Sometimes you want to read it from an environment variable. Sometimes you want to read it from a config file.

And in some very special times, you want to allow the value to be passed using some combination of the three.

The appsettings module provides an argparse subclass that allows pulling settings from the command line, environment variables, or a yaml config file.

If the same value is provided in several of those locations, then env var always beats config file, and command line always beats everything.

Usage is exactly the same as argparse, with the addition of some new kwargs on initializing the parser and adding arguments to it. Example:

from appsettings import SettingsParser

f = open('some_config_file.yaml')
parser  = SettingsParser(yaml_file=f)

parser.add_argument('--color', default='blue', env_var='FAVCOLOR')

args = parser.parse_args()

print args.color
# If you've set the FAVCOLOR environment variable you should now see its
# value printed to the console.  Otherwise you'd see 'blue'

Things to Know

Options Only

Only long form arguments like “–color” will provide env var and config file fallbacks. Positional arguments and short options like “-c” will behave just like they do in the argparse module.

APP_SETTINGS_YAML

If you don’t provide a yaml_file argument to the SettingsParser constructor, and the APP_SETTINGS_YAML environment variable is set, then that file will be read and parsed to provide settings. (Though they’ll still be overridable by environment variables and command line options.)

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

appsettings-0.8.tar.gz (3.8 kB view details)

Uploaded Source

File details

Details for the file appsettings-0.8.tar.gz.

File metadata

  • Download URL: appsettings-0.8.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for appsettings-0.8.tar.gz
Algorithm Hash digest
SHA256 8aa90699a67a90edf88b11b6f5d539506daee4395f7e6bbae62c5e6505b2ddd6
MD5 1181cede5c13378f4dd6b404c0936c8e
BLAKE2b-256 c05bce768ca9fcbdb8bdb41b6c6032b0ebd12532b18670a10b5e4b5a01d67899

See more details on using hashes here.

Provenance

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