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
Hashes for json-schema-env-validator-1.0.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4ec7393d424e70d0007ac5b11a6a4c7c0f1ea1cc2b4cf1ec3b2160186ae34eb |
|
MD5 | 17d176c43604f1df03fea79987b54fec |
|
BLAKE2b-256 | 0b199717fc58a82228ba1173868b3e61e119e596d5b97e06274d18f3a6727ffe |