JSON Schema应用程序环境配置和验证

此软件包允许您使用JSON模式验证用于配置的应用程序环境变量。

在Docker/kubernetes中使用它非常有用，您可能有很多来自环境变量的配置；然而，它也提供了一个很好的通用方法，用于使用JSON Schema定义和验证任何应用程序配置。

用法

首先，定义一个JSON Schema文件(env-schema.json)

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

然后，验证您的环境配置(export DB_URI=postgresql://localhost:5432)

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

验证多个文件

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

您还可以将现有对象与JSON模式文件进行验证

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

或命令行验证

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

开发

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