Skip to main content

Parsing and validation of environment variables

Project description

https://travis-ci.org/cknv/envargs.svg?branch=master https://coveralls.io/repos/github/cknv/envargs/badge.svg?branch=master

Simple means of parsing and validating environment variables. Heavily inspired by the earlier versions of webargs, which also explains the name to some extend.

Installing

$ pip install envargs

Using

from envargs import Var, parse_env

required_vars = {
    'A_INT': Var(
        use=int,
        validate=lambda x: x >= 0,
    ),
    'A_LIST': Var(
        use=lambda x: x.split(','),
        validate=(
            lambda x: len(x) == 2,
            lambda x: x[0] == 'first element',
        ),
    ),
    'A_STR': Var(
        use=str,
        load_from='SOME_OTHER_NAME',
        validate=bool,
    ),
}

parsed = parse_env(required_vars)

Say you want to configure your Flask app using this:

app.config.from_mapping(parsed)

Why reinvent the wheel again?

To be fair there are many good packages out there to parse environment variables, quite a few of them in python too. So this package can easily be seen as redundant. However, with separation of parsing and validation into two separate functions, you gain more power to control what is actually accepted, not to mention that it makes it possible to inline a few more things, as you can most often get away with using builtin functions for most parsing and validation, and when that is not enough, lambdas or partials can do the rest.

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

envargs-0.2.1.tar.gz (3.9 kB view hashes)

Uploaded Source

Built Distribution

envargs-0.2.1-py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 3

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