GeneralManager 0.5.1__tar.gz → 0.6.0__tar.gz

{generalmanager-0.5.1 → generalmanager-0.6.0}/GeneralManager.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.5.1
-Summary: Kurzbeschreibung deines Pakets
+Version: 0.6.0
+Summary: Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.
 Author-email: Tim Kleindick <tkleindick@yahoo.de>
 License-Expression: MIT
 Requires-Python: >=3.12
@@ -37,51 +37,51 @@ Dynamic: license-file
 
 # GeneralManager
 
-## Überblick
+## Overview
 
-Das GeneralManager-Modul ist ein leistungsstarkes und flexibles Framework, das speziell für die Verwaltung und Verarbeitung von Daten entwickelt wurde. Es bietet eine modulare Struktur, die es Entwicklern ermöglicht, komplexe Geschäftslogiken effizient zu implementieren und zu verwalten. Das Modul ist vollständig in Python geschrieben und nutzt Django als Backend-Framework.
+GeneralManager is a powerful and flexible framework designed for managing and processing data. It provides a modular structure that enables developers to implement complex business logic efficiently. The module is written entirely in Python and uses Django as the backend framework.
 
-## Hauptfunktionen
+## Key Features
 
-### 1. **Datenmanagement**
-- **Flexibilität**: Unterstützt die Verwaltung aller Arten von Daten, nicht nur Projekte und Derivate.
-- **Datenbank-Integration**: Nahtlose Integration mit dem Django ORM für Datenbankoperationen.
-- **Externe Schnittstellen**: Unterstützung für Schnittstellen zu anderen Programmen, wie z. B. Excel-Interfaces.
+### 1. **Data Management**
+- **Flexibility**: Supports managing all kinds of data, not just projects and derivatives.
+- **Database Integration**: Seamless integration with the Django ORM for database operations.
+- **External Interfaces**: Support for interfaces to other programs, such as Excel.
 
-### 2. **Datenmodellierung**
-- **Django-Modelle**: Die Datenstruktur basiert auf Django-Modellen, die durch benutzerdefinierte Felder wie `MeasurementField` erweitert werden.
-- **Regeln und Validierungen**: Definieren Sie Regeln für Datenvalidierungen, z. B. dass das Startdatum eines Projekts vor dem Enddatum liegen muss.
+### 2. **Data Modeling**
+- **Django Models**: The data structure is based on Django models, extended by custom fields like `MeasurementField`.
+- **Rules and Validations**: Define rules for data validation, e.g., ensuring that a project's start date is before its end date.
 
-### 3. **GraphQL-Integration**
-- Automatische Generierung von GraphQL-Schnittstellen für alle Modelle.
-- Unterstützung für benutzerdefinierte Abfragen und Mutationen.
+### 3. **GraphQL Integration**
+- Automatic generation of GraphQL interfaces for all models.
+- Support for custom queries and mutations.
 
-### 4. **Berechtigungssystem**
-- **ManagerBasedPermission**: Ein flexibles Berechtigungssystem, das auf Benutzerrollen und Attributen basiert.
-- Unterstützung für CRUD-Berechtigungen auf Attributebene.
+### 4. **Permission System**
+- **ManagerBasedPermission**: A flexible permission system based on user roles and attributes.
+- Attribute-level CRUD permissions.
 
 ### 5. **Interfaces**
-- **CalculationInterface**: Ermöglicht die Implementierung von Berechnungslogiken.
-- **DatabaseInterface**: Bietet eine standardisierte Schnittstelle für Datenbankoperationen.
-- **ReadOnlyInterface**: Für schreibgeschützte Datenzugriffe.
+- **CalculationInterface**: Allows the implementation of calculation logic.
+- **DatabaseInterface**: Provides a standardized interface for database operations.
+- **ReadOnlyInterface**: For read-only data access.
 
-### 6. **Datenverteilung und Berechnung**
-- **Volumenverteilung**: Automatische Berechnung und Verteilung von Volumen über mehrere Jahre.
-- **Kommerzielle Berechnungen**: Berechnung von Gesamtvolumen, Versandkosten und Einnahmen für Projekte.
+### 6. **Data Distribution and Calculations**
+- **Volume Distribution**: Automatically calculates and distributes volume over multiple years.
+- **Commercial Calculations**: Calculates total volume, shipping costs, and revenue for projects.
 
-## Anwendung
+## Usage
 
 ### Installation
 
-Installieren Sie das Modul über `pip`:
+Install the module via `pip`:
 
 ```bash
 pip install GeneralManager
 ```
 
-### Beispielcode
+### Example Code
 
-Hier ist ein Beispiel, wie Sie einen GeneralManager erstellen und Testdaten (in diesem Fall 10 Projekte) generieren können:
+The following example demonstrates how to create a GeneralManager and generate sample data (in this case 10 projects):
 
 ```python
 from general_manager import GeneralManager
@@ -134,11 +134,11 @@ class Project(GeneralManager):
 Project.Factory.createBatch(10)
 ```
 
-### GraphQL-Integration
+### GraphQL Integration
 
-Das Modul generiert automatisch GraphQL-Schnittstellen für alle Modelle. Sie können Abfragen und Mutationen über die GraphQL-URL ausführen, die in den Django-Einstellungen definiert ist.
+The module automatically generates GraphQL endpoints for all models. You can run queries and mutations through the GraphQL URL defined in your Django settings.
 
-Beispiel für eine GraphQL-Abfrage:
+Example of a GraphQL query:
 
 ```graphql
 query {
@@ -154,26 +154,26 @@ query {
 }
 ```
 
-## Vorteile
+## Benefits
 
-- **Modularität**: Einfach erweiterbar und anpassbar.
-- **Flexibilität**: Unterstützt komplexe Geschäftslogiken und Berechnungen.
-- **Integration**: Nahtlose Integration mit Django und GraphQL.
-- **Berechtigungen**: Fein abgestimmte Berechtigungen für Benutzer und Attribute.
-- **Datenvalidierung**: Automatische Validierung von Daten durch Regeln und Constraints.
-- **Caching**: Automatische Cache-Generierung mit @cached Decorator, um die Leistung zu verbessern.
+- **Modularity**: Easy to extend and adapt.
+- **Flexibility**: Supports complex business logic and calculations.
+- **Integration**: Seamless integration with Django and GraphQL.
+- **Permissions**: Fine-grained permissions for users and attributes.
+- **Data Validation**: Automatic validation of data through rules and constraints.
+- **Caching**: Automatic cache generation with the `@cached` decorator to improve performance.
 
-## Anforderungen
+## Requirements
 
 - Python >= 3.12
 - Django >= 5.2
-- Zusätzliche Abhängigkeiten (siehe `requirements.txt`):
+- Additional dependencies (see `requirements.txt`):
   - `graphene`
   - `numpy`
   - `Pint`
   - `factory_boy`
-  - uvm.
+  - and more.
 
-## Lizenz
+## License
 
-Dieses Projekt steht unter der **Non-Commercial MIT License**. Es darf nur für nicht-kommerzielle Zwecke verwendet werden. Weitere Details finden Sie in der [LICENSE](./LICENSE).
+This project is distributed under the **Non-Commercial MIT License**. It may only be used for non-commercial purposes. For further details see the [LICENSE](./LICENSE) file.

{generalmanager-0.5.1 → generalmanager-0.6.0}/GeneralManager.egg-info/SOURCES.txt

@@ -18,6 +18,10 @@ src/general_manager/auxiliary/jsonEncoder.py
 src/general_manager/auxiliary/makeCacheKey.py
 src/general_manager/auxiliary/noneToZero.py
 src/general_manager/auxiliary/pathMapping.py
+src/general_manager/bucket/baseBucket.py
+src/general_manager/bucket/calculationBucket.py
+src/general_manager/bucket/databaseBucket.py
+src/general_manager/bucket/groupBucket.py
 src/general_manager/cache/cacheDecorator.py
 src/general_manager/cache/cacheTracker.py
 src/general_manager/cache/dependencyIndex.py
@@ -30,7 +34,9 @@ src/general_manager/factory/factoryMethods.py
 src/general_manager/interface/__init__.py
 src/general_manager/interface/baseInterface.py
 src/general_manager/interface/calculationInterface.py
+src/general_manager/interface/databaseBasedInterface.py
 src/general_manager/interface/databaseInterface.py
+src/general_manager/interface/readOnlyInterface.py
 src/general_manager/manager/__init__.py
 src/general_manager/manager/generalManager.py
 src/general_manager/manager/groupManager.py
@@ -50,9 +56,13 @@ src/general_manager/rule/handler.py
 src/general_manager/rule/rule.py
 tests/test_argsToKwargs.py
 tests/test_autoFactory.py
+tests/test_baseBucket.py
+tests/test_baseInterface.py
 tests/test_basePermission.py
 tests/test_cacheDecorator.py
 tests/test_cacheTracker.py
+tests/test_dabaseBasedInterface.py
+tests/test_databaseBucket.py
 tests/test_dependencyIndex.py
 tests/test_factories.py
 tests/test_factoryMethods.py

{generalmanager-0.5.1 → generalmanager-0.6.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: GeneralManager
-Version: 0.5.1
-Summary: Kurzbeschreibung deines Pakets
+Version: 0.6.0
+Summary: Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching.
 Author-email: Tim Kleindick <tkleindick@yahoo.de>
 License-Expression: MIT
 Requires-Python: >=3.12
@@ -37,51 +37,51 @@ Dynamic: license-file
 
 # GeneralManager
 
-## Überblick
+## Overview
 
-Das GeneralManager-Modul ist ein leistungsstarkes und flexibles Framework, das speziell für die Verwaltung und Verarbeitung von Daten entwickelt wurde. Es bietet eine modulare Struktur, die es Entwicklern ermöglicht, komplexe Geschäftslogiken effizient zu implementieren und zu verwalten. Das Modul ist vollständig in Python geschrieben und nutzt Django als Backend-Framework.
+GeneralManager is a powerful and flexible framework designed for managing and processing data. It provides a modular structure that enables developers to implement complex business logic efficiently. The module is written entirely in Python and uses Django as the backend framework.
 
-## Hauptfunktionen
+## Key Features
 
-### 1. **Datenmanagement**
-- **Flexibilität**: Unterstützt die Verwaltung aller Arten von Daten, nicht nur Projekte und Derivate.
-- **Datenbank-Integration**: Nahtlose Integration mit dem Django ORM für Datenbankoperationen.
-- **Externe Schnittstellen**: Unterstützung für Schnittstellen zu anderen Programmen, wie z. B. Excel-Interfaces.
+### 1. **Data Management**
+- **Flexibility**: Supports managing all kinds of data, not just projects and derivatives.
+- **Database Integration**: Seamless integration with the Django ORM for database operations.
+- **External Interfaces**: Support for interfaces to other programs, such as Excel.
 
-### 2. **Datenmodellierung**
-- **Django-Modelle**: Die Datenstruktur basiert auf Django-Modellen, die durch benutzerdefinierte Felder wie `MeasurementField` erweitert werden.
-- **Regeln und Validierungen**: Definieren Sie Regeln für Datenvalidierungen, z. B. dass das Startdatum eines Projekts vor dem Enddatum liegen muss.
+### 2. **Data Modeling**
+- **Django Models**: The data structure is based on Django models, extended by custom fields like `MeasurementField`.
+- **Rules and Validations**: Define rules for data validation, e.g., ensuring that a project's start date is before its end date.
 
-### 3. **GraphQL-Integration**
-- Automatische Generierung von GraphQL-Schnittstellen für alle Modelle.
-- Unterstützung für benutzerdefinierte Abfragen und Mutationen.
+### 3. **GraphQL Integration**
+- Automatic generation of GraphQL interfaces for all models.
+- Support for custom queries and mutations.
 
-### 4. **Berechtigungssystem**
-- **ManagerBasedPermission**: Ein flexibles Berechtigungssystem, das auf Benutzerrollen und Attributen basiert.
-- Unterstützung für CRUD-Berechtigungen auf Attributebene.
+### 4. **Permission System**
+- **ManagerBasedPermission**: A flexible permission system based on user roles and attributes.
+- Attribute-level CRUD permissions.
 
 ### 5. **Interfaces**
-- **CalculationInterface**: Ermöglicht die Implementierung von Berechnungslogiken.
-- **DatabaseInterface**: Bietet eine standardisierte Schnittstelle für Datenbankoperationen.
-- **ReadOnlyInterface**: Für schreibgeschützte Datenzugriffe.
+- **CalculationInterface**: Allows the implementation of calculation logic.
+- **DatabaseInterface**: Provides a standardized interface for database operations.
+- **ReadOnlyInterface**: For read-only data access.
 
-### 6. **Datenverteilung und Berechnung**
-- **Volumenverteilung**: Automatische Berechnung und Verteilung von Volumen über mehrere Jahre.
-- **Kommerzielle Berechnungen**: Berechnung von Gesamtvolumen, Versandkosten und Einnahmen für Projekte.
+### 6. **Data Distribution and Calculations**
+- **Volume Distribution**: Automatically calculates and distributes volume over multiple years.
+- **Commercial Calculations**: Calculates total volume, shipping costs, and revenue for projects.
 
-## Anwendung
+## Usage
 
 ### Installation
 
-Installieren Sie das Modul über `pip`:
+Install the module via `pip`:
 
 ```bash
 pip install GeneralManager
 ```
 
-### Beispielcode
+### Example Code
 
-Hier ist ein Beispiel, wie Sie einen GeneralManager erstellen und Testdaten (in diesem Fall 10 Projekte) generieren können:
+The following example demonstrates how to create a GeneralManager and generate sample data (in this case 10 projects):
 
 ```python
 from general_manager import GeneralManager
@@ -134,11 +134,11 @@ class Project(GeneralManager):
 Project.Factory.createBatch(10)
 ```
 
-### GraphQL-Integration
+### GraphQL Integration
 
-Das Modul generiert automatisch GraphQL-Schnittstellen für alle Modelle. Sie können Abfragen und Mutationen über die GraphQL-URL ausführen, die in den Django-Einstellungen definiert ist.
+The module automatically generates GraphQL endpoints for all models. You can run queries and mutations through the GraphQL URL defined in your Django settings.
 
-Beispiel für eine GraphQL-Abfrage:
+Example of a GraphQL query:
 
 ```graphql
 query {
@@ -154,26 +154,26 @@ query {
 }
 ```
 
-## Vorteile
+## Benefits
 
-- **Modularität**: Einfach erweiterbar und anpassbar.
-- **Flexibilität**: Unterstützt komplexe Geschäftslogiken und Berechnungen.
-- **Integration**: Nahtlose Integration mit Django und GraphQL.
-- **Berechtigungen**: Fein abgestimmte Berechtigungen für Benutzer und Attribute.
-- **Datenvalidierung**: Automatische Validierung von Daten durch Regeln und Constraints.
-- **Caching**: Automatische Cache-Generierung mit @cached Decorator, um die Leistung zu verbessern.
+- **Modularity**: Easy to extend and adapt.
+- **Flexibility**: Supports complex business logic and calculations.
+- **Integration**: Seamless integration with Django and GraphQL.
+- **Permissions**: Fine-grained permissions for users and attributes.
+- **Data Validation**: Automatic validation of data through rules and constraints.
+- **Caching**: Automatic cache generation with the `@cached` decorator to improve performance.
 
-## Anforderungen
+## Requirements
 
 - Python >= 3.12
 - Django >= 5.2
-- Zusätzliche Abhängigkeiten (siehe `requirements.txt`):
+- Additional dependencies (see `requirements.txt`):
   - `graphene`
   - `numpy`
   - `Pint`
   - `factory_boy`
-  - uvm.
+  - and more.
 
-## Lizenz
+## License
 
-Dieses Projekt steht unter der **Non-Commercial MIT License**. Es darf nur für nicht-kommerzielle Zwecke verwendet werden. Weitere Details finden Sie in der [LICENSE](./LICENSE).
+This project is distributed under the **Non-Commercial MIT License**. It may only be used for non-commercial purposes. For further details see the [LICENSE](./LICENSE) file.

generalmanager-0.6.0/README.md

@@ -0,0 +1,142 @@
+# GeneralManager
+
+## Overview
+
+GeneralManager is a powerful and flexible framework designed for managing and processing data. It provides a modular structure that enables developers to implement complex business logic efficiently. The module is written entirely in Python and uses Django as the backend framework.
+
+## Key Features
+
+### 1. **Data Management**
+- **Flexibility**: Supports managing all kinds of data, not just projects and derivatives.
+- **Database Integration**: Seamless integration with the Django ORM for database operations.
+- **External Interfaces**: Support for interfaces to other programs, such as Excel.
+
+### 2. **Data Modeling**
+- **Django Models**: The data structure is based on Django models, extended by custom fields like `MeasurementField`.
+- **Rules and Validations**: Define rules for data validation, e.g., ensuring that a project's start date is before its end date.
+
+### 3. **GraphQL Integration**
+- Automatic generation of GraphQL interfaces for all models.
+- Support for custom queries and mutations.
+
+### 4. **Permission System**
+- **ManagerBasedPermission**: A flexible permission system based on user roles and attributes.
+- Attribute-level CRUD permissions.
+
+### 5. **Interfaces**
+- **CalculationInterface**: Allows the implementation of calculation logic.
+- **DatabaseInterface**: Provides a standardized interface for database operations.
+- **ReadOnlyInterface**: For read-only data access.
+
+### 6. **Data Distribution and Calculations**
+- **Volume Distribution**: Automatically calculates and distributes volume over multiple years.
+- **Commercial Calculations**: Calculates total volume, shipping costs, and revenue for projects.
+
+## Usage
+
+### Installation
+
+Install the module via `pip`:
+
+```bash
+pip install GeneralManager
+```
+
+### Example Code
+
+The following example demonstrates how to create a GeneralManager and generate sample data (in this case 10 projects):
+
+```python
+from general_manager import GeneralManager
+from general_manager.interface.database import DatabaseInterface
+from general_manager.measurement import MeasurementField, Measurement
+from general_manager.permission import ManagerBasedPermission
+
+class Project(GeneralManager):
+    name: str
+    start_date: Optional[date]
+    end_date: Optional[date]
+    total_capex: Optional[Measurement]
+    derivative_list: DatabaseBucket[Derivative]
+
+    class Interface(DatabaseInterface):
+        name = CharField(max_length=50)
+        number = CharField(max_length=7, validators=[RegexValidator(r"^AP\d{4,5}$")])
+        description = TextField(null=True, blank=True)
+        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 Meta:
+            constraints = [
+                constraints.UniqueConstraint(
+                    fields=["name", "number"], name="unique_booking"
+                )
+            ]
+
+            rules = [
+                Rule["Project"](
+                    lambda x: cast(date, x.start_date) < cast(date, x.end_date)
+                ),
+                Rule["Project"](lambda x: cast(Measurement, x.total_capex) >= "0 EUR"),
+            ]
+
+        class Factory:
+            name = LazyProjectName()
+            end_date = LazyDeltaDate(365 * 6, "start_date")
+            total_capex = LazyMeasurement(75_000, 1_000_000, "EUR")
+
+    class Permission(ManagerBasedPermission):
+        __read__ = ["ends_with:name:X-771", "public"]
+        __create__ = ["admin", "isMatchingKeyAccount"]
+        __update__ = ["admin", "isMatchingKeyAccount", "isProjectTeamMember"]
+        __delete__ = ["admin", "isMatchingKeyAccount", "isProjectTeamMember"]
+
+        total_capex = {"update": ["isSalesResponsible", "isProjectManager"]}
+
+Project.Factory.createBatch(10)
+```
+
+### GraphQL Integration
+
+The module automatically generates GraphQL endpoints for all models. You can run queries and mutations through the GraphQL URL defined in your Django settings.
+
+Example of a GraphQL query:
+
+```graphql
+query {
+  projectList {
+    name
+    startDate
+    endDate
+    totalCapex {
+      value
+      unit
+    }
+  }
+}
+```
+
+## Benefits
+
+- **Modularity**: Easy to extend and adapt.
+- **Flexibility**: Supports complex business logic and calculations.
+- **Integration**: Seamless integration with Django and GraphQL.
+- **Permissions**: Fine-grained permissions for users and attributes.
+- **Data Validation**: Automatic validation of data through rules and constraints.
+- **Caching**: Automatic cache generation with the `@cached` decorator to improve performance.
+
+## Requirements
+
+- Python >= 3.12
+- Django >= 5.2
+- Additional dependencies (see `requirements.txt`):
+  - `graphene`
+  - `numpy`
+  - `Pint`
+  - `factory_boy`
+  - and more.
+
+## License
+
+This project is distributed under the **Non-Commercial MIT License**. It may only be used for non-commercial purposes. For further details see the [LICENSE](./LICENSE) file.

{generalmanager-0.5.1 → generalmanager-0.6.0}/pyproject.toml

@@ -1,18 +1,13 @@
 [build-system]
-requires = [
-    "setuptools>=42",
-    "wheel",
-]
+requires = ["setuptools>=42", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "GeneralManager"
-version = "0.5.1"
-description = "Kurzbeschreibung deines Pakets"
+version = "0.6.0"
+description = "Modular Django-based data management framework with ORM, GraphQL, fine-grained permissions, rule validation, calculations and caching."
 readme = "README.md"
-authors = [
-    { name = "Tim Kleindick", email = "tkleindick@yahoo.de" },
-]
+authors = [{ name = "Tim Kleindick", email = "tkleindick@yahoo.de" }]
 license = "MIT"
 license-files = ["LICENSE"]
 requires-python = ">=3.12"
@@ -46,19 +41,16 @@ dependencies = [
 ]
 
 [tool.setuptools.packages.find]
-where = [
-    "src",
-    "general_manager",
-]
+where = ["src", "general_manager"]
 
 [tool.semantic_release]
-allow_zero_version    = true
-major_on_zero         = false
-version_toml          = ["pyproject.toml:project.version"]
-branch                = "main"
-build_command         = "python -m build"
-upload_to_PyPI        = true
-upload_to_release     = true
+allow_zero_version = true
+major_on_zero = false
+version_toml = ["pyproject.toml:project.version"]
+branch = "main"
+build_command = "python -m build"
+upload_to_PyPI = true
+upload_to_release = true
 
 [tool.semantic_release.remote]
 ignore_token_for_push = true

{generalmanager-0.5.1 → generalmanager-0.6.0}/src/general_manager/api/graphql.py

@@ -9,7 +9,8 @@ import json
 from general_manager.measurement.measurement import Measurement
 from general_manager.manager.generalManager import GeneralManagerMeta, GeneralManager
 from general_manager.api.property import GraphQLProperty
-from general_manager.interface.baseInterface import InterfaceBase, Bucket
+from general_manager.bucket.baseBucket import Bucket
+from general_manager.interface.baseInterface import InterfaceBase
 
 if TYPE_CHECKING:
     from general_manager.permission.basePermission import BasePermission