Skip to main content

No project description provided

Project description

JSON Schema Application Environment Configuration and Validation

This package allows you to validate application environment variables that are used for configuration with JSON schemas.

It is extremely useful to use with Docker/kubernetes where you might have quite a bit of configuration originating from environment variables; however, it also provides a nice generic way to define and validate any application configuration with JSON Schema.

Usage

First, define a JSON Schema file(env-schema.json):

{
    "$schema": "http://json-schema.org/draft-07/schema#", 
    "type": "object",
  
    "properties": {
        "db_uri": {
            "type": "string",
            "title": "AMQP host"
        }
    },
    "required": ["db_uri"]
}

Then, validate your environment config(export DB_URI=postgresql://localhost:5432):

import enviral
settings = enviral.validate_env('env-schema.json')
settings['db_uri']

Validate with multiple files:

import enviral
settings = enviral.validate_env('env-schema.json', 'package:validation-file.json')

You can also validate existing objects against JSON schema files:

import enviral
enviral.validate_object({"db_uri": "postgresql://localhost:5432"}, 'env-schema.json')

Or command line validate:

json-schema-env-validator env-schema.json package:validation-file.json

Development

pip install -r requirements.txt
pip install -e .
./bin/pre-commit install

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

json-schema-env-validator-1.0.2.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distribution

json_schema_env_validator-1.0.2-py3-none-any.whl (5.4 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