django-sysconfig 1.0.0

A Magento-style system configuration app for Django

django-sysconfig

Runtime configuration for Django. Define typed config fields in code, store values in the database, edit everything through a built-in admin UI — without touching settings.py.

---

Why django-sysconfig?

Some settings belong in settings.py. Others — feature flags, rate limits, API keys, email addresses — need to change at runtime without a redeploy, often by someone who isn't an engineer.

django-sysconfig gives those settings a proper home: a typed schema in code, values in the database, and a clean staff UI to manage them.

---

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 change maintenance_mode through /admin/config/ — no code change, no redeploy.

---

What's included

• 7 field types — string, integer, decimal, boolean, select, textarea, encrypted secret
• 20 built-in validators — email, URL, IP, hostname, port, range, regex, slug, JSON, and more
• Auto-discovery — drop a sysconfig.py in any installed app, it's picked up on startup
• Typed accessor — config.get(...) always returns the correct Python type
• Caching — values are cached via Django's cache framework, invalidated on every write
• Encryption at rest — secret fields use Fernet symmetric encryption
• on_save callbacks — react to value changes with custom logic
• Management commands — config get, config set, config import, config export

---

Requirements

	Minimum
Python	3.11
Django	4.2
cryptography	41.0

---

Documentation

krishnamodepalli.github.io/django-sysconfig

---

Contributing

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