Skip to main content

Schema-driven, database-backed runtime configuration app for Django

Project description

django-sysconfig

PyPI version Python versions CI License

Schema-driven, database-backed runtime configuration for Django.

Define typed config fields in code. Store values in the database. Edit everything live through a built-in admin UI — without touching settings.py.

django-sysconfig demo


Install

pip install django-sysconfig
# settings.py
INSTALLED_APPS = [
    "django_sysconfig",   # add at the top
    ...
]
python manage.py migrate

Quick example

# myapp/sysconfig.py
from django_sysconfig.registry import register_config, Section, Field
from django_sysconfig.frontend_models import BooleanFrontendModel, IntegerFrontendModel
from django_sysconfig.validators import RangeValidator

@register_config("myapp")
class MyAppConfig:
    class General(Section):
        label = "General"

        maintenance_mode = Field(BooleanFrontendModel, label="Maintenance Mode", default=False)
        max_items = Field(IntegerFrontendModel, label="Max Items", default=100,
                          validators=[RangeValidator(min_value=1, max_value=10_000)])
# anywhere in your project
from django_sysconfig.accessor import config

if config.get("myapp.general.maintenance_mode"):
    return HttpResponse("Down for maintenance.", status=503)

Staff can toggle maintenance_mode at /admin/config/ — no code change, no redeploy.


Documentation

Full guides, API reference, and examples are in the docs.


Contributing

See CONTRIBUTING.md. Issues and pull requests are welcome.


Security

Please do not open a public issue for security vulnerabilities. Report them privately via GitHub Security Advisories.

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

django_sysconfig-1.0.2.tar.gz (46.2 kB view details)

Uploaded Source

Built Distribution

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

django_sysconfig-1.0.2-py3-none-any.whl (42.0 kB view details)

Uploaded Python 3

File details

Details for the file django_sysconfig-1.0.2.tar.gz.

File metadata

  • Download URL: django_sysconfig-1.0.2.tar.gz
  • Upload date:
  • Size: 46.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for django_sysconfig-1.0.2.tar.gz
Algorithm Hash digest
SHA256 012e79fa63f63504b70e0e2a96e622c783f7ec3c5383bc6eed87fd9dd904213f
MD5 8edcade071d6eb78d7bc820a48463546
BLAKE2b-256 60412a12eec5ac97474a0242277c35136d0acd2e3f3cf68db3f89267e03356ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_sysconfig-1.0.2.tar.gz:

Publisher: release.yml on krishnamodepalli/django-sysconfig

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_sysconfig-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for django_sysconfig-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 060d6c42cb58d387fa7026cb877806c96c9a5748136c15b8cbd56ca12b1f4080
MD5 c07d8bd9f7ffc94748033528deb085a7
BLAKE2b-256 5498b8d487bf40816c93151c9131519772bd6cd47ea45c15294e1ee9edb0e5ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_sysconfig-1.0.2-py3-none-any.whl:

Publisher: release.yml on krishnamodepalli/django-sysconfig

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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