Skip to main content

Schema-based environment variable validation with type coercion and helpful error messages

Project description

philiprehberger-env-validator

Tests PyPI version License

Schema-based environment variable validation with type coercion and helpful error messages.

Installation

pip install philiprehberger-env-validator

Usage

Basic Validation

from philiprehberger_env_validator import Schema, validate

schema = (
    Schema()
    .string("DATABASE_URL", description="PostgreSQL connection string")
    .integer("PORT", default=3000)
    .boolean("DEBUG", default=False)
    .string("NODE_ENV", choices=["development", "staging", "production"])
)

config = validate(schema)
print(config["PORT"])  # 3000 (int, not string)

Field Types

schema = (
    Schema()
    .string("API_KEY")
    .integer("MAX_CONNECTIONS")
    .float_field("RATE_LIMIT")
    .boolean("VERBOSE")
    .url("WEBHOOK_URL")
    .email("ADMIN_EMAIL")
)

Custom Validation

schema = Schema().string(
    "API_KEY",
    pattern=r"^sk-[a-zA-Z0-9]{32}$",
    validator=lambda v: len(v) > 10,
)

Optional Fields

schema = (
    Schema()
    .string("REQUIRED_VAR")
    .string("OPTIONAL_VAR", required=False, default="fallback")
)

Custom Source

config = validate(schema, source={"PORT": "8080", "DEBUG": "true"})

Error Handling

from philiprehberger_env_validator import ValidationError

try:
    config = validate(schema)
except ValidationError as e:
    for error in e.errors:
        print(error)

Development

pip install -e .
python -m pytest tests/ -v

License

MIT

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

philiprehberger_env_validator-0.1.5.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_env_validator-0.1.5-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_env_validator-0.1.5.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_env_validator-0.1.5.tar.gz
Algorithm Hash digest
SHA256 e1293a691c1a6b627a1f4a8c47c950e2c13db353a63598ad0040cc9dc851ffa0
MD5 84dce3bc8c241d86d031f1a9a0f25100
BLAKE2b-256 ba7b904d78fbaaac7c6b57dab0f4be967d18dc901a49f68bea6de5ab9274cfb0

See more details on using hashes here.

File details

Details for the file philiprehberger_env_validator-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_env_validator-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1e22f004e7fcf791def68b05b29c7e41c1afe31c3682fb9e00a806acd2fac1b8
MD5 645bc8647e06b6464709008b60402ff0
BLAKE2b-256 52e1865d6125ab3744834860b3d5d49ddaed03997fc697deb9eb459832b6a400

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page