This project has been archived by its maintainers, and is no longer receiving any updates.
Django microSYS - System Integration Service
Open microSYS Agent on ChatGPT
Specialized custom GPT for django-microsys integration, configuration, extension, and troubleshooting.
microSYS is a multilingual Django app that gives a project-level system layer for user management, branding, translations, scopes, navigation, activity logging, guided onboarding, data export, and dynamic CRUD tooling. It is not just a themed admin shell: it is a fairly large internal-systems toolkit that bundles runtime configuration, user operations, auditability, UI infrastructure, and zero-boilerplate management patterns into one package. The package keeps the landing README short, You can view the long-form operating and integration guidance at docs/.
What microSYS gives you
- A first-launch setup wizard at
/sys/setup/for identity, explicit language catalog management, translation-matrix overrides, access/security toggles, UI-first Microsys email delivery, themes, default table density, global home URL, and sidebar structure, including full sidebar disable, runtime sidebar-toolbar, and user-reordering controls. - A runtime system UI for users and superusers, including Options, user management, profiles, 2FA, activity logs, scopes, and system settings.
- A disabled-by-default public registration playground for email-first local signup with mandatory email verification, Microsys email readiness checks, public-account provenance badges, throttles, and optional approval.
- A database-backed
SystemSettingssingleton layered overMICROSYS_CONFIG, so projects can seed defaults in code and refine them in the UI later. - A framework-owned
django_tables2platform that auto-adopts stock tables, ships built-in pagination and per-page controls, exposes a publicMicrosysTablebase class, and supports per-tablemicrosys_table,microsys_density,microsys_per_page, andmicrosys_actionsoverrides. - A
ScopedModelbase with audit fields, soft-delete behavior, actor tracking, filtered managers, and automatic scope handling. - Zero-boilerplate sections and dynamic modal CRUD flows for auxiliary models, plus a reusable context-menu/event model for richer interactions.
- A built-in audit trail with signal-based logging, merged User/Profile updates, diff capture, masked sensitive fields, and download/export log entries.
- Universal data helpers such as
fetch_file,fetch_excel, sticky-form autofill, tutorial overlays, and persistent UI preferences.
Requirements
note: all the requirements will be installed automatically when you install django-microsys.
- Python 3.11+
- Django 5.1+
django-crispy-formscrispy-bootstrap5django-tables2django-filterpillow"for image handling"babel"for translations"psutil"for system monitoring"pyotp"for TOTP 2FA"qrcode"for TOTP 2FA QR codes"cryptography"for encrypted TOTP and SMTP secret storage"
Installation
pip install django-microsys
# OR
pip install git+https://github.com/debeski/django-microsys.git
Scaffold a New Project or App
python -m microsys startproject myproject
cd myproject
python -m microsys startapp billing --register
python -m microsys startproject creates a new Django project already wired for MicroSys. python -m microsys startapp creates a MicroSys-native app skeleton with models, forms, filters, tables, translations, templates, tests, and optional project registration.
Generated projects also include a baseline Docker stack with compose.yml, compose.dev.yml, a config/celery.py worker entrypoint, and a /health/ endpoint via django-health-check.
They also generate .secrets/.env with the bootstrap secrets used by the standard decrypter/startup flow.
The scaffolded settings baseline now also includes django-cors-headers and django-csp with their apps, middleware, and starter CORS/CSP policy settings.
Minimal Quick Start
- Add the MicroSys helper at the end of your project
settings.py.
from microsys.utils import microsys_settings
microsys_settings(globals())
That helper prepends the required apps, inserts django.middleware.locale.LocaleMiddleware and microsys.middleware.MicrosysMiddleware in the supported order, adds the Microsys context processor, sets the Crispy Bootstrap 5 defaults, adds a Bootstrap-friendly MESSAGE_TAGS error mapping, and seeds the standard MicroSys runtime defaults for language, timezone, i18n/tz flags, FORMAT_MODULE_PATH, and charset unless your project already defines them.
Proceed to Getting Started if you prefer to wire everything manually.
Public registration is documented separately at Public Registration Playground. It is disabled by default and is not part of the optional SSO packages.
- Mount
microsys.urlsat project root so the bundled auth and system routes stay at/accounts/...and/sys/....
from django.urls import include, path
urlpatterns = [
path("", include("microsys.urls")),
]
With that root include in place, microsys provides /accounts/... and /sys/.... If your project does not define its own / view, microsys falls back from an unresolved / request into its login/setup flow instead of leaving a 404. On a fresh and unconfigured install, Microsys also guards ordinary anonymous requests so a public root page cannot bypass first-time setup; once setup is complete, your existing root view continues to behave normally.
- Run the setup command.
python manage.py microsys_setup
- Sign in as a superuser and complete the first-launch wizard at
/sys/setup/. On a fresh install, an anonymous request may be sent through/sys/setup/and then to login before the wizard can be completed. After setup, the main runtime UI lives underuser_hub.
For a fuller setup path, prefix-mount guidance, and first-launch expectations, use the Getting Started guide.
Key Capabilities
- Onboarding and runtime configuration: first-launch setup wizard, Options view, runtime System Settings modal, source-tabbed translation overrides, setup import/export, language/theme defaults, and a global Home destination.
- User and security operations: interactive user wizard, grouped translated permissions, four-tier staff authorization (superuser, Global Staff, Central Staff, Scoped Staff), permission-based sidebar visibility, profile management, multiple 2FA flows (App, Email, Backup), trusted device tracking for 30 days, and runtime preference persistence.
- Generic CRUD infrastructure: dynamic sections, AJAX-driven modal CRUD, automatic form/table/filter discovery, context-menu actions, and reusable event dispatch.
- Navigation and UI infrastructure: resolver-driven sidebar builder with permission-based visibility, runtime tree rendering, optional user-level reordering, configurable sidebar toolbar visibility, a shared theme registry, tutorial overlays, theme-aware system surfaces, and template injection hooks.
- Data movement and productivity helpers: universal file download, Excel export, smart autofill, sticky-form cloning, and generic list/filter helpers.
- Audit and governance: signal-based activity logging with configurable IP resolution (direct/proxy/header), diff capture, masked sensitive fields, deduplicated entries, download/export logging, and scoped visibility.
- Optional SSO:
django-microsys-ssoanddjango-microsys-sso-clientlive as separate optional packages for OIDC provider/client deployments without changing core Microsys runtime behavior. - Standalone backup viewer:
tools/msb-viewer/is a dependency-free, cross-platform binary for inspecting encrypted.msbsystem backups offline — browse models, rows, and stored files without a running instance. Prebuilt binaries ship with each release. - Framework-level automation: translation patches, scoped-model auto-injection, actor tracking, soft-delete, and config layering across defaults, project settings, and runtime UI.
Documentation
- Documentation Hub
- Security Policy
- Contributing Guide
- Code of Conduct
- Getting Started
- Admin Guide
- Developer Guide
- Customization Guide
- Reference
- MSRP-1 Security Standard
- Optional SSO Packages
- Standalone .msb Backup Viewer
- Releasing — tag-driven PyPI + GitHub release flow
- Features — complete feature inventory
- Changelog
1 maintainer
Metadata
1 maintainer
Release files for django-microsys 2.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| django_microsys-2.4.1.tar.gz | 2.0 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_microsys-2.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.1 MB
Release files / django_microsys-2.4.1.tar.gz
| Download URL | django_microsys-2.4.1.tar.gz |
|---|---|
| Size | 2.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
48f6c0595a75e403faa650db892b422da60859439d9a6ff8177679d16e7fbc05
|
|
BLAKE2b-256 checksum How to use checksums |
adb4b46411b0f85effed405fb6d4ccdfd17cf620958764ef1eaa2ab7a5aa157c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency logRelease files / django_microsys-2.4.1-py3-none-any.whl
| Download URL | django_microsys-2.4.1-py3-none-any.whl |
|---|---|
| Size | 2.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
30efa7c03938ada425282d528126d07919c621dcb762c2c1bbedc18a98dab4bf
|
|
BLAKE2b-256 checksum How to use checksums |
017ee55f5e30ba964d35bbd8771c16d89507a692766494605d709fd1347457dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency logSecurity for django-microsys 2.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for django_microsys-2.4.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
