| Name | GeneralManager JSON |
| Version |
0.17.0
JSON |
| download |
| home_page | None |
| Summary | Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching. |
| upload_time | 2025-10-19 20:06:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License Copyright (c) 2025 Tim Kleindick Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
orm
graphql
permissions
validation
caching
framework
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GeneralManager
[](https://pypi.org/project/GeneralManager/)
[](https://pypi.org/project/GeneralManager/)
[](https://github.com/TimKleindick/general_manager/actions/workflows/test.yml)
[](https://app.codecov.io/gh/TimKleindick/general_manager)
[](LICENSE)
## Overview
GeneralManager helps teams ship complex, data-driven products on top of Django without rewriting the same plumbing for every project. It combines domain modelling, GraphQL APIs, calculations, and permission logic in one toolkit so that you can focus on business rules instead of infrastructure.
## Documentation
The full documentation is published on GitHub Pages: [GeneralManager Documentation](https://timkleindick.github.io/general_manager/). It covers tutorials, concept guides, API reference, and examples.
## Key Features
- **Domain-first modelling**: Describe rich business entities in plain Python and let GeneralManager project them onto the Django ORM.
- **GraphQL without boilerplate**: Generate a complete API, then extend it with custom queries and mutations when needed.
- **Attribute-based access control**: Enforce permissions with `ManagerBasedPermission` down to single fields and operations.
- **Deterministic calculations**: Ship reusable interfaces e.g. for volume distributions, KPI calculations, and derived data.
- **Factory-powered testing**: Create large, realistic datasets quickly for demos, QA, and load tests.
- **Composable interfaces**: Connect to databases, spreadsheets, or computed sources with the same consistent abstractions.
## Quick Start
### Installation
Install the package from PyPI:
```bash
pip install GeneralManager
```
### Minimal example
```python
from datetime import date
from typing import Optional
from django.db.models import CharField, DateField
from general_manager import GeneralManager
from general_manager.interface.database import DatabaseInterface
from general_manager.measurement import Measurement, MeasurementField
from general_manager.permission import ManagerBasedPermission
class Project(GeneralManager):
name: str
start_date: Optional[date]
end_date: Optional[date]
total_capex: Optional[Measurement]
class Interface(DatabaseInterface):
name = CharField(max_length=50)
start_date = DateField(null=True, blank=True)
end_date = DateField(null=True, blank=True)
total_capex = MeasurementField(base_unit="EUR", null=True, blank=True)
class Permission(ManagerBasedPermission):
__read__ = ["public"]
__create__ = ["isAdmin"]
__update__ = ["isAdmin"]
Project.Factory.createBatch(10)
```
The example above defines a project model, exposes it through the auto-generated GraphQL schema, and produces ten sample records with a single call. The full documentation walks through extending this setup with custom rules, interfaces, and queries.
## Core Building Blocks
- **Entities & interfaces**: Compose domain entities with database-backed or computed interfaces to control persistence and data flows.
- **Rules & validation**: Protect your data with declarative constraints and business rules that run automatically.
- **Permissions**: Implement attribute-based access control with reusable policies that match your organisation’s roles.
- **GraphQL layer**: Serve a typed schema that mirrors your models and stays in sync as you iterate.
- **Caching & calculations**: Use the built-in caching decorator and calculation helpers to keep derived data fast and reliable.
## Production-Ready Extras
- Works with Postgres, SQLite, and any database supported by Django.
- Plays nicely with CI thanks to deterministic factories, typing, and code coverage.
- Ships with MkDocs documentation, auto-generated API reference, and a growing cookbook of recipes.
- Designed for teams: opinionated defaults without blocking custom extensions or overrides.
## Use Cases
- Internal tooling that mirrors real-world workflows, pricing models, or asset hierarchies.
- Customer-facing platforms that combine transactional data with live calculations.
- Analytics products that need controlled data sharing between teams or clients.
- Proof-of-concept projects that must scale into production without a rewrite.
## Requirements
- Python >= 3.12
- Django >= 5.2
- Additional dependencies (see `requirements/base.txt`):
- `graphene`
- `numpy`
- `Pint`
- `factory_boy`
- and more.
## License
This project is distributed under the **MIT License**. For further details see the [LICENSE](./LICENSE) file.
Raw data
{
"_id": null,
"home_page": null,
"name": "GeneralManager",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "django, orm, graphql, permissions, validation, caching, framework",
"author": null,
"author_email": "Tim Kleindick <tkleindick@yahoo.de>",
"download_url": "https://files.pythonhosted.org/packages/de/e0/b8f69d07d1077b7fbb1275a6e9286ee517c6cfd35d3ede3b918b57053d7a/generalmanager-0.17.0.tar.gz",
"platform": null,
"description": "# GeneralManager\n\n[](https://pypi.org/project/GeneralManager/)\n[](https://pypi.org/project/GeneralManager/)\n[](https://github.com/TimKleindick/general_manager/actions/workflows/test.yml)\n[](https://app.codecov.io/gh/TimKleindick/general_manager)\n[](LICENSE)\n\n## Overview\n\nGeneralManager helps teams ship complex, data-driven products on top of Django without rewriting the same plumbing for every project. It combines domain modelling, GraphQL APIs, calculations, and permission logic in one toolkit so that you can focus on business rules instead of infrastructure.\n\n## Documentation\n\nThe full documentation is published on GitHub Pages: [GeneralManager Documentation](https://timkleindick.github.io/general_manager/). It covers tutorials, concept guides, API reference, and examples.\n\n## Key Features\n\n- **Domain-first modelling**: Describe rich business entities in plain Python and let GeneralManager project them onto the Django ORM.\n- **GraphQL without boilerplate**: Generate a complete API, then extend it with custom queries and mutations when needed.\n- **Attribute-based access control**: Enforce permissions with `ManagerBasedPermission` down to single fields and operations.\n- **Deterministic calculations**: Ship reusable interfaces e.g. for volume distributions, KPI calculations, and derived data.\n- **Factory-powered testing**: Create large, realistic datasets quickly for demos, QA, and load tests.\n- **Composable interfaces**: Connect to databases, spreadsheets, or computed sources with the same consistent abstractions.\n\n## Quick Start\n\n### Installation\n\nInstall the package from PyPI:\n\n```bash\npip install GeneralManager\n```\n\n### Minimal example\n\n```python\nfrom datetime import date\nfrom typing import Optional\n\nfrom django.db.models import CharField, DateField\n\nfrom general_manager import GeneralManager\nfrom general_manager.interface.database import DatabaseInterface\nfrom general_manager.measurement import Measurement, MeasurementField\nfrom general_manager.permission import ManagerBasedPermission\n\n\nclass Project(GeneralManager):\n name: str\n start_date: Optional[date]\n end_date: Optional[date]\n total_capex: Optional[Measurement]\n\n class Interface(DatabaseInterface):\n name = CharField(max_length=50)\n start_date = DateField(null=True, blank=True)\n end_date = DateField(null=True, blank=True)\n total_capex = MeasurementField(base_unit=\"EUR\", null=True, blank=True)\n\n class Permission(ManagerBasedPermission):\n __read__ = [\"public\"]\n __create__ = [\"isAdmin\"]\n __update__ = [\"isAdmin\"]\n\n\nProject.Factory.createBatch(10)\n```\n\nThe example above defines a project model, exposes it through the auto-generated GraphQL schema, and produces ten sample records with a single call. The full documentation walks through extending this setup with custom rules, interfaces, and queries.\n\n## Core Building Blocks\n\n- **Entities & interfaces**: Compose domain entities with database-backed or computed interfaces to control persistence and data flows.\n- **Rules & validation**: Protect your data with declarative constraints and business rules that run automatically.\n- **Permissions**: Implement attribute-based access control with reusable policies that match your organisation\u2019s roles.\n- **GraphQL layer**: Serve a typed schema that mirrors your models and stays in sync as you iterate.\n- **Caching & calculations**: Use the built-in caching decorator and calculation helpers to keep derived data fast and reliable.\n\n## Production-Ready Extras\n\n- Works with Postgres, SQLite, and any database supported by Django.\n- Plays nicely with CI thanks to deterministic factories, typing, and code coverage.\n- Ships with MkDocs documentation, auto-generated API reference, and a growing cookbook of recipes.\n- Designed for teams: opinionated defaults without blocking custom extensions or overrides.\n\n## Use Cases\n\n- Internal tooling that mirrors real-world workflows, pricing models, or asset hierarchies.\n- Customer-facing platforms that combine transactional data with live calculations.\n- Analytics products that need controlled data sharing between teams or clients.\n- Proof-of-concept projects that must scale into production without a rewrite.\n\n## Requirements\n\n- Python >= 3.12\n- Django >= 5.2\n- Additional dependencies (see `requirements/base.txt`):\n - `graphene`\n - `numpy`\n - `Pint`\n - `factory_boy`\n - and more.\n\n## License\n\nThis project is distributed under the **MIT License**. For further details see the [LICENSE](./LICENSE) file.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Tim Kleindick Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.",
"version": "0.17.0",
"project_urls": {
"Changelog": "https://github.com/TimKleindick/general_manager/releases",
"Documentation": "https://timkleindick.github.io/general_manager/",
"Homepage": "https://github.com/TimKleindick/general_manager",
"Issues": "https://github.com/TimKleindick/general_manager/issues",
"Repository": "https://github.com/TimKleindick/general_manager"
},
"split_keywords": [
"django",
" orm",
" graphql",
" permissions",
" validation",
" caching",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "113697d9c1bf60616463e0acf716d9411da19de844fe1f349d65b7c480c1f434",
"md5": "cb9207ba92b5b45d5074137728b6ed7c",
"sha256": "689e1eb230267079e8e2a8edb8e9fa6c4057160a7b6cf3364f7392dd44e06031"
},
"downloads": -1,
"filename": "generalmanager-0.17.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb9207ba92b5b45d5074137728b6ed7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 134006,
"upload_time": "2025-10-19T20:06:20",
"upload_time_iso_8601": "2025-10-19T20:06:20.000368Z",
"url": "https://files.pythonhosted.org/packages/11/36/97d9c1bf60616463e0acf716d9411da19de844fe1f349d65b7c480c1f434/generalmanager-0.17.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dee0b8f69d07d1077b7fbb1275a6e9286ee517c6cfd35d3ede3b918b57053d7a",
"md5": "b4a64c233e438c67c7295a5e198ee358",
"sha256": "4c542153ed540ecddf850c961b3a07c1af40c70ee92db69a9e2ef7ffdf9028cd"
},
"downloads": -1,
"filename": "generalmanager-0.17.0.tar.gz",
"has_sig": false,
"md5_digest": "b4a64c233e438c67c7295a5e198ee358",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 103572,
"upload_time": "2025-10-19T20:06:21",
"upload_time_iso_8601": "2025-10-19T20:06:21.324554Z",
"url": "https://files.pythonhosted.org/packages/de/e0/b8f69d07d1077b7fbb1275a6e9286ee517c6cfd35d3ede3b918b57053d7a/generalmanager-0.17.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-19 20:06:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TimKleindick",
"github_project": "general_manager",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "generalmanager"
}
