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.1.tar.gz (47.3 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.1-py3-none-any.whl (41.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_sysconfig-1.0.1.tar.gz
  • Upload date:
  • Size: 47.3 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.1.tar.gz
Algorithm Hash digest
SHA256 1397cf8264540ae88cc07f16331b31eacea741d202db84313b70d7ed8ae4c1fd
MD5 c4beea8b08755d8faf625a83cbe0f67e
BLAKE2b-256 04193efc2ab58b91575213f6531910210dc09c375d4447127b25b999aa235ce4

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_sysconfig-1.0.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_sysconfig-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3441197c16c78f05e1c807906ebf8bbfee4d70538dede2866805e1f75eb5f216
MD5 4237b2b3468436fb20c941b57ad859d7
BLAKE2b-256 c65b754c3a9cef596065def47c4e98150ba7adbffbfeef61ec7807338f55bb07

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_sysconfig-1.0.1-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