Skip to main content

Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.

Project description

GeneralManager

PyPI Python Build Coverage License: MIT

GeneralManager is a typed, declarative framework for building data-rich Django applications. Define domain objects once, then use the same model through the Django ORM, generated GraphQL, permission policies, validation, calculations, search, and workflows.

GeneralManager is pre-1.0. The main branch and latest PyPI release can differ; use the release history to distinguish published behavior from current development.

What GeneralManager provides

Domain models and interfaces

Start with the architecture overview and interface concepts.

APIs, permissions, and validation

Data and operations

Development and optional integrations

Compatibility

  • Python 3.12 or newer
  • Django 5.2.15 or newer
  • CI exercises Python 3.12, 3.13, and 3.14 on SQLite

GeneralManager builds on Django's database layer, but this project only claims backend support covered by its tests or maintained examples. SQLite, PostgreSQL, and MariaDB are exercised by CI and are fully supported. Other Django-supported backends may work, but are not currently claimed as supported by GeneralManager.

Five-minute setup

Start in an empty directory. On macOS or Linux:

mkdir general-manager-demo
cd general-manager-demo
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install GeneralManager
django-admin startproject gm_demo .
python manage.py startapp projects

Append the following to gm_demo/settings.py:

INSTALLED_APPS += [
    "general_manager",
    "projects.apps.ProjectsConfig",
]

AUTOCREATE_GRAPHQL = True
GRAPHQL_URL = "graphql/"
ALLOWED_HOSTS = ["127.0.0.1", "localhost", "testserver"]

Create projects/managers.py:

from typing import ClassVar

from django.db.models import CharField

from general_manager import GeneralManager
from general_manager.interface import DatabaseInterface
from general_manager.permission import AdditiveManagerPermission


class Project(GeneralManager):
    name: str

    class Interface(DatabaseInterface):
        name = CharField(max_length=100)

    class Permission(AdditiveManagerPermission):
        __read__: ClassVar[list[str]] = ["public"]
        __create__: ClassVar[list[str]] = ["isAuthenticated"]
        __update__: ClassVar[list[str]] = ["isAuthenticated"]
        __delete__: ClassVar[list[str]] = ["isAuthenticated"]

GeneralManager discovers managers.py modules in installed Django applications during startup, so no manual import in AppConfig.ready() is needed. Create the generated model's migration, initialize the database, and seed one demo record:

python manage.py makemigrations projects
python manage.py migrate
python manage.py shell -c 'from projects.managers import Project; Project.Factory.create(name="Apollo")'
python manage.py runserver

Project.Factory.create(...) is intended here for demo seeding. Application writes should run through an authenticated permission context.

In another terminal, retrieve the record through generated GraphQL. This GET request is copyable without a CSRF token:

curl --get 'http://127.0.0.1:8000/graphql/' \
  --data-urlencode 'query=query { projectList { items { name } } }'

Expected response:

{"data":{"projectList":{"items":[{"name":"Apollo"}]}}}

You now have a typed manager, generated Django model, migration, persisted record, permission policy, and generated GraphQL query. Continue with the annotated quickstart for Windows activation, framework behavior, and troubleshooting.

Documentation

Project links

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

generalmanager-0.65.0.tar.gz (713.1 kB view details)

Uploaded Source

Built Distribution

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

generalmanager-0.65.0-py3-none-any.whl (852.0 kB view details)

Uploaded Python 3

File details

Details for the file generalmanager-0.65.0.tar.gz.

File metadata

  • Download URL: generalmanager-0.65.0.tar.gz
  • Upload date:
  • Size: 713.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.13

File hashes

Hashes for generalmanager-0.65.0.tar.gz
Algorithm Hash digest
SHA256 c8486cd7674e729f53e15656b682f57b77ba0e97491234ea113fdfb4cf166c58
MD5 968fe9039cfd4bbd348dd585082a3457
BLAKE2b-256 8e4f29624aa6ad0a61313f6321fab35a49293b67a2afacee3d9cfc3a64e27707

See more details on using hashes here.

File details

Details for the file generalmanager-0.65.0-py3-none-any.whl.

File metadata

  • Download URL: generalmanager-0.65.0-py3-none-any.whl
  • Upload date:
  • Size: 852.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.13

File hashes

Hashes for generalmanager-0.65.0-py3-none-any.whl
Algorithm Hash digest
SHA256 171d7855fd710db2d90db4164dd59b7ad5e5a3e7cb9ec7a8fb7671f04906deea
MD5 74a5e82abb022b1f1407f285e41864c9
BLAKE2b-256 47648d9375675299db399a818eae5408ede2f6256357e04832c63220d7971e9e

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