django-mindoff 0.1.2__tar.gz

django_mindoff-0.1.2/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, MindOff
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_mindoff-0.1.2/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+graft apps/django_mindoff
+prune apps/django_mindoff/tests
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

django_mindoff-0.1.2/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: django-mindoff
+Version: 0.1.2
+Summary: Architectural framework for reliable, scalable Django REST APIs with native Polars.
+Author: Joel Samraj
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/mindoffwork/django-mindoff
+Project-URL: Documentation, https://github.com/mindoffwork/django-mindoff#readme
+Project-URL: Source, https://github.com/mindoffwork/django-mindoff.git
+Project-URL: Issues, https://github.com/mindoffwork/django-mindoff/issues
+Project-URL: Changelog, https://github.com/mindoffwork/django-mindoff/blob/main/CHANGELOG.md
+Keywords: django,django-rest-framework,drf,api,api-development,code-generation,scaffolding,automation,boilerplate,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=5.0
+Requires-Dist: djangorestframework>=3.15.0
+Requires-Dist: polars>=1.0.0
+Dynamic: license-file
+
+# django-mindoff
+
+`django-mindoff` is an architectural framework designed to eliminate repetitive API setup so developers can focus on business logic instead of infrastructure, scaffolding, and version coordination.
+
+It combines project automation, standardized API architecture, structured responses, testing utilities, and Polars-powered workflows into one cohesive system.
+
+## Project Status 🧪
+
+`django-mindoff` is currently experimental and in active development. Architecture, philosophy, functionality and structure may evolve. It is designed for fresh Django-Mindoff projects and is not intended for retrofitting into existing Django applications.
+
+## Requirements ⚙️
+
+- Python ≥ 3.12
+
+All other framework dependencies are managed internally. `django-mindoff` selects compatible versions of Django, DRF, and Polars so you do not have to manage version alignment manually.
+
+## Installation 📦
+
+```bash
+pip install django-mindoff
+```
+
+## Quick Start 🚀
+
+### 1. Initialize a Project
+
+```bash
+django-mindoff init
+```
+
+Creates a fully structured Django-Mindoff project with:
+
+- Virtual environment
+- `.env` configuration
+- Git initialization (if available)
+- Preconfigured architecture
+
+### 2. Create Apps, Models, and APIs
+
+```bash
+python mindoff.py create
+```
+
+Interactive CLI allows you to:
+
+- Create apps → `apps/<app_name>/`
+- Create models → `apps/<app_name>/models.py`
+- Create APIs → `apps/<app_name>/apis/<api_name>.py`
+- Auto-register routes
+
+### 3. Add Your Logic
+
+Edit your generated API and return structured responses:
+
+```python
+return mo_response_kit.json_response(
+    code="SUCCESS",
+    category="success",
+    data={"message": "Hello World"}
+)
+```
+
+Run the server. Focus on your logic. Repeat.
+
+---
+
+## Response Standard 📄
+
+All responses follow a consistent structure:
+
+```json
+{
+	"status": "ok",
+	"message": {
+		"code": "SUCCESS",
+		"title": "Success",
+		"description": "Operation completed successfully.",
+		"category": "success"
+	},
+	"data": {
+		"id": "ec4786f7-3646-4159-a091-7c83ba3addaf",
+		"name": "John Doe"
+	}
+}
+```
+
+No unstructured exceptions. No inconsistent payloads.
+Umm... One more thing. `django-mindoff` uses uuids for primary keys and foreign keys by design.
+
+## Architecture 🧭
+
+### Versioned Routing
+
+```
+<int:version>/<app_name>
+```
+
+Routers resolve the correct API version automatically.
+
+### Project Structure 📁
+
+A freshly generated project follows this layout:
+
+```text
+project_root/
+├─ manage.py
+├─ mindoff.py
+├─ pytest.ini
+├─ README.md
+├─ .env
+│
+├─ config/
+│  ├─ settings.py
+│  ├─ urls.py
+│  ├─ asgi.py
+│  ├─ wsgi.py
+│  └─ Responses.csv
+│
+├─ templates/
+│  ├─ index.html
+│  └─ 404.html
+│
+└─ apps/
+   └─ <app_name>/
+      ├─ apps.py
+      ├─ models.py
+      ├─ serializers.py
+      ├─ views.py
+      ├─ urls.py
+      ├─ apis/
+      │  └─ <api_name>.py
+      ├─ components/
+      │  └─ <component_name>.py
+      └─ tests/
+         ├─ test_views.py
+         └─ test_apis/
+            └─ test_<api_name>.py
+```
+
+## Core Kits 🧰
+
+Mindoff is modular. Each kit removes a specific category of friction.
+
+**1. Project Management Kit:**
+Prompt-driven CLI for creating and organizing projects, apps, models, and APIs.
+
+**2. API Kit:**
+Centralized configuration layer handling validation, security, documentation, and error handling.
+
+**3. CRUD Kit:**
+Polars `DataFrame` and `LazyFrame` driven database operations with validation.
+
+**4. Polars Kit:**
+High-performance utilities for streaming-safe frame operations.
+
+**5. Validation Kit:**
+Single-line validation helpers that reduce conditional complexity.
+
+**6. Response Kit:**
+Structured JSON, file, text, and HTML responses.
+
+**7. TDD Kit:**
+Testing base classes and helpers for rapid API testing.
+
+## CLI Overview 🛠️
+
+```bash
+django-mindoff init      # Create project
+django-mindoff delete    # Delete project
+python mindoff.py create # Create app/model/api
+python mindoff.py delete # Delete app
+```
+
+## Testing ✅
+
+`MindoffTestCase` provides:
+
+- Pytest integration
+- Mock app and model generation
+- Polars DataFrame and LazyFrame support
+- Assertion helpers
+
+## Configuration ⚙️
+
+Optional settings in `settings.py`:
+
+```python
+MINDOFF_LOG_ERRORS_IN_DEBUG = False
+MINDOFF_TRACEBACK_DIRS = ["apps", "config"]
+REDIS_URL = config("REDIS_URL")
+POLARS_VALIDATOR_ERROR_COL = "__error__info"
+MINDOFF_USE_VIEW_CACHE = False
+```
+
+`.env` is auto-generated during initialization.

django_mindoff-0.1.2/README.md

@@ -0,0 +1,195 @@
+# django-mindoff
+
+`django-mindoff` is an architectural framework designed to eliminate repetitive API setup so developers can focus on business logic instead of infrastructure, scaffolding, and version coordination.
+
+It combines project automation, standardized API architecture, structured responses, testing utilities, and Polars-powered workflows into one cohesive system.
+
+## Project Status 🧪
+
+`django-mindoff` is currently experimental and in active development. Architecture, philosophy, functionality and structure may evolve. It is designed for fresh Django-Mindoff projects and is not intended for retrofitting into existing Django applications.
+
+## Requirements ⚙️
+
+- Python ≥ 3.12
+
+All other framework dependencies are managed internally. `django-mindoff` selects compatible versions of Django, DRF, and Polars so you do not have to manage version alignment manually.
+
+## Installation 📦
+
+```bash
+pip install django-mindoff
+```
+
+## Quick Start 🚀
+
+### 1. Initialize a Project
+
+```bash
+django-mindoff init
+```
+
+Creates a fully structured Django-Mindoff project with:
+
+- Virtual environment
+- `.env` configuration
+- Git initialization (if available)
+- Preconfigured architecture
+
+### 2. Create Apps, Models, and APIs
+
+```bash
+python mindoff.py create
+```
+
+Interactive CLI allows you to:
+
+- Create apps → `apps/<app_name>/`
+- Create models → `apps/<app_name>/models.py`
+- Create APIs → `apps/<app_name>/apis/<api_name>.py`
+- Auto-register routes
+
+### 3. Add Your Logic
+
+Edit your generated API and return structured responses:
+
+```python
+return mo_response_kit.json_response(
+    code="SUCCESS",
+    category="success",
+    data={"message": "Hello World"}
+)
+```
+
+Run the server. Focus on your logic. Repeat.
+
+---
+
+## Response Standard 📄
+
+All responses follow a consistent structure:
+
+```json
+{
+	"status": "ok",
+	"message": {
+		"code": "SUCCESS",
+		"title": "Success",
+		"description": "Operation completed successfully.",
+		"category": "success"
+	},
+	"data": {
+		"id": "ec4786f7-3646-4159-a091-7c83ba3addaf",
+		"name": "John Doe"
+	}
+}
+```
+
+No unstructured exceptions. No inconsistent payloads.
+Umm... One more thing. `django-mindoff` uses uuids for primary keys and foreign keys by design.
+
+## Architecture 🧭
+
+### Versioned Routing
+
+```
+<int:version>/<app_name>
+```
+
+Routers resolve the correct API version automatically.
+
+### Project Structure 📁
+
+A freshly generated project follows this layout:
+
+```text
+project_root/
+├─ manage.py
+├─ mindoff.py
+├─ pytest.ini
+├─ README.md
+├─ .env
+│
+├─ config/
+│  ├─ settings.py
+│  ├─ urls.py
+│  ├─ asgi.py
+│  ├─ wsgi.py
+│  └─ Responses.csv
+│
+├─ templates/
+│  ├─ index.html
+│  └─ 404.html
+│
+└─ apps/
+   └─ <app_name>/
+      ├─ apps.py
+      ├─ models.py
+      ├─ serializers.py
+      ├─ views.py
+      ├─ urls.py
+      ├─ apis/
+      │  └─ <api_name>.py
+      ├─ components/
+      │  └─ <component_name>.py
+      └─ tests/
+         ├─ test_views.py
+         └─ test_apis/
+            └─ test_<api_name>.py
+```
+
+## Core Kits 🧰
+
+Mindoff is modular. Each kit removes a specific category of friction.
+
+**1. Project Management Kit:**
+Prompt-driven CLI for creating and organizing projects, apps, models, and APIs.
+
+**2. API Kit:**
+Centralized configuration layer handling validation, security, documentation, and error handling.
+
+**3. CRUD Kit:**
+Polars `DataFrame` and `LazyFrame` driven database operations with validation.
+
+**4. Polars Kit:**
+High-performance utilities for streaming-safe frame operations.
+
+**5. Validation Kit:**
+Single-line validation helpers that reduce conditional complexity.
+
+**6. Response Kit:**
+Structured JSON, file, text, and HTML responses.
+
+**7. TDD Kit:**
+Testing base classes and helpers for rapid API testing.
+
+## CLI Overview 🛠️
+
+```bash
+django-mindoff init      # Create project
+django-mindoff delete    # Delete project
+python mindoff.py create # Create app/model/api
+python mindoff.py delete # Delete app
+```
+
+## Testing ✅
+
+`MindoffTestCase` provides:
+
+- Pytest integration
+- Mock app and model generation
+- Polars DataFrame and LazyFrame support
+- Assertion helpers
+
+## Configuration ⚙️
+
+Optional settings in `settings.py`:
+
+```python
+MINDOFF_LOG_ERRORS_IN_DEBUG = False
+MINDOFF_TRACEBACK_DIRS = ["apps", "config"]
+REDIS_URL = config("REDIS_URL")
+POLARS_VALIDATOR_ERROR_COL = "__error__info"
+MINDOFF_USE_VIEW_CACHE = False
+```
+
+`.env` is auto-generated during initialization.

django_mindoff-0.1.2/apps/django_mindoff/__init__.py

@@ -0,0 +1,7 @@
+default_app_config = "django_mindoff.apps.DjangoMindoffConfig"
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("django-mindoff")
+except PackageNotFoundError:
+    __version__ = "unknown"

django_mindoff-0.1.2/apps/django_mindoff/apps.py

@@ -0,0 +1,12 @@
+from django.apps import AppConfig
+
+from .components.response_kit import load_responses_csv
+
+
+class DjangoMindoffConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = __name__.rpartition(".")[0]
+
+    def ready(self):
+        load_responses_csv()
+        from . import checks

django_mindoff-0.1.2/apps/django_mindoff/checks.py

@@ -0,0 +1,65 @@
+from django.core.checks import Error, register
+from django.urls import get_resolver
+from django.urls.resolvers import URLResolver, URLPattern
+from django.core.exceptions import ImproperlyConfigured
+from django.apps import apps as django_apps
+from inspect import isclass
+import inspect
+import importlib
+import pkgutil
+import sys
+
+from .components.api_kit import MindoffAPIMixin
+
+
+@register()
+def check_mindoff_api_configs(app_configs, **kwargs):
+    errors = []
+
+    for app_config in django_apps.get_app_configs():
+        apis_dir = (
+            app_config.path and __import__("pathlib").Path(app_config.path) / "apis"
+        )
+        if not apis_dir or not apis_dir.is_dir():
+            continue
+
+        # Walk every .py file under apis/ and import it fresh
+        package_name = f"{app_config.name}.apis"
+        for finder, module_name, _ in pkgutil.walk_packages(
+            path=[str(apis_dir)],
+            prefix=f"{package_name}.",
+            onerror=lambda name: None,
+        ):
+            # Force a fresh import — evict any cached version first
+            sys.modules.pop(module_name, None)
+            try:
+                module = importlib.import_module(module_name)
+            except Exception:
+                continue
+
+            for attr_name in dir(module):
+                obj = getattr(module, attr_name, None)
+                if (
+                    isclass(obj)
+                    and issubclass(obj, MindoffAPIMixin)
+                    and obj is not MindoffAPIMixin
+                ):
+                    _validate_view_class(obj, errors)
+
+    return errors
+
+
+def _validate_view_class(view_class, errors):
+    try:
+        instance = view_class()
+        instance.validate_api_configuration()
+    except Exception as exc:
+        error_code = getattr(exc, "code", "API_CONFIG_ERR")
+        errors.append(
+            Error(
+                f"API Configuration Error in {view_class.__name__}: {str(exc)}",
+                hint="Check validate_api_configuration() in your API class.",
+                obj=view_class,
+                id=f"django_mindoff.{error_code}",
+            )
+        )

django_mindoff-0.1.2/apps/django_mindoff/cli.py

@@ -0,0 +1,19 @@
+import argparse
+import importlib
+
+
+def main():
+    parser = argparse.ArgumentParser(prog="django-mindoff")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    for name in ["init", "nuke"]:
+        module = importlib.import_module(f"django_mindoff.components.managers.{name}")
+        if hasattr(module, "register_subcommand"):
+            module.register_subcommand(subparsers)
+
+    args = parser.parse_args()
+
+    if hasattr(args, "handler"):
+        args.handler(args)
+    else:
+        parser.print_help()