djangospice-framework 0.1.0__tar.gz

djangospice_framework-0.1.0/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

djangospice_framework-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/djangospice_framework
+
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install build
+        run: python -m pip install --upgrade build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

djangospice_framework-0.1.0/.gitignore

@@ -0,0 +1,55 @@
+# Python
+__pycache__/
+*.py[cod]
+*.so
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# Packaging
+build/
+dist/
+*.egg-info/
+*.egg
+
+# Testing / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+
+# Type checking / linters
+.mypy_cache/
+.ruff_cache/
+
+# Environment / secrets
+.env
+.env.*
+*.pem
+
+# IDEs / editors
+.vscode/
+*.code-workspace
+.idea/
+
+# OS files
+.DS_Store
+.AppleDouble
+.Trashes
+Thumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Documentation
+docs/_build/
+
+# Misc
+*.log
+*.tmp
+*~

djangospice_framework-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 briansimpo
+
+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.

djangospice_framework-0.1.0/PKG-INFO

@@ -0,0 +1,261 @@
+Metadata-Version: 2.5
+Name: djangospice-framework
+Version: 0.1.0
+Summary: Application Runtime Framework for building Django apps.
+Project-URL: Homepage, https://github.com/briansimpo/djangospice_framework
+Project-URL: Documentation, https://github.com/briansimpo/djangospice_framework#readme
+Project-URL: Source, https://github.com/briansimpo/djangospice_framework
+Project-URL: Issues, https://github.com/briansimpo/djangospice_framework/issues
+Author-email: Brian Simpokolwe <briansimpokolwe@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: django,djangospice_framework,framework,modular,runtime
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5
+Classifier: Framework :: Django :: 6
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.12
+Requires-Dist: asgiref>=3.8
+Requires-Dist: celery>=5.4
+Requires-Dist: channels-redis>=4.2
+Requires-Dist: channels>=4.1
+Requires-Dist: django-celery-beat>=2.6
+Requires-Dist: django-filter>=24.0
+Requires-Dist: django-import-export>=4.2
+Requires-Dist: django-model-utils>=4.5
+Requires-Dist: django-tables2>=2.7
+Requires-Dist: django>=5.0
+Requires-Dist: djangorestframework>=3.15
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: premailer>=3.10
+Requires-Dist: psycopg[binary]>=3.1
+Requires-Dist: python-slugify>=8.0
+Requires-Dist: semver>=3.0
+Requires-Dist: setuptools>=80.9
+Requires-Dist: tablib[all]>=3.7
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: coverage; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-django; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# djangospice_framework
+
+**Application Runtime Framework for building Django apps**
+
+`djangospice_framework` is the application runtime for building modular Django applications.
+
+It is designed to provide a consistent foundation for building large Django application ecosystems without repeatedly implementing the same infrastructure in every application.
+
+---
+
+## Why djangospice_framework?
+
+Large Django projects often accumulate infrastructure that gets duplicated across applications.
+
+For example, individual applications may independently implement:
+
+* Base models
+* Event dispatching
+* Job handling
+* File handling
+* Import/export pipelines
+* Realtime broadcasting
+* Common service abstractions
+
+djangospice_framework provides these capabilities as a shared runtime.
+
+This gives applications a common architecture and allows modules to remain focused on their actual domain.
+
+### Design goals
+
+djangospice_framework is designed around several principles:
+
+* **Reusable** — common functionality should be implemented once.
+* **Modular** — functionality should be composed through independent components.
+* **Extensible** — applications should be able to replace or extend framework behavior.
+* **Django-native** — use Django's existing ecosystem rather than reinventing it.
+* **Developer-friendly** — common application infrastructure should require minimal boilerplate.
+
+---
+
+## Installation
+
+Install djangospice_framework from PyPI:
+
+```bash
+pip install djangospice_framework
+```
+
+---
+
+## Basic Usage
+
+Once installed, djangospice_framework components can be imported by Django applications and modules.
+
+For example, using the common model infrastructure:
+
+```python
+from djangospice_framework.db.models import BaseModel
+
+
+class Customer(BaseModel):
+    name = models.CharField(max_length=255)
+```
+
+The exact capabilities available depend on the components being used by the application.
+
+---
+
+# Core Components
+
+djangospice_framework is organized around reusable infrastructure rather than business-domain applications.
+
+## Database and Models
+
+Common Django model abstractions provide a consistent foundation for application models.
+
+```python
+from djangospice_framework.db.models import BaseModel
+```
+
+The database layer is intended to eliminate repetitive model infrastructure while preserving normal Django ORM behavior.
+
+---
+
+## Events
+
+The event system provides a decoupled mechanism for applications to communicate.
+
+Instead of tightly coupling one application component to another, a component can dispatch an event and allow listeners to react to it.
+
+Conceptually:
+
+```text
+Application Action
+       │
+       ▼
+     Event
+       │
+       ├── Listener
+       ├── Listener
+       └── Listener
+```
+
+This allows functionality such as notifications, auditing, integrations, and background processing to be attached without modifying the original application logic.
+
+---
+
+## Broadcasting and Realtime Communication
+
+The runtime provides abstractions for broadcasting application events and data to users or groups.
+
+For example:
+
+```python
+Broadcast.everyone(...)
+```
+
+or:
+
+```python
+Broadcast.user(user, ...)
+```
+
+This infrastructure can be used by applications that need realtime updates through WebSockets or other supported transports.
+
+---
+
+## Async Support
+
+The runtime provides common abstractions for asynchronous application functionality.
+
+This allows modules to use async operations where appropriate while keeping common infrastructure in one place.
+
+---
+
+## Files
+
+djangospice_framework provides common abstractions for file-related functionality, allowing applications to work with files without repeatedly implementing storage and file-handling patterns.
+
+---
+
+## Imports and Exports
+
+Reusable import/export infrastructure allows applications to implement data exchange consistently.
+
+Typical use cases include:
+
+* CSV imports
+* Spreadsheet imports
+* Data exports
+* Bulk operations
+* Integration pipelines
+
+---
+
+# Application Modules
+
+djangospice_framework is **not intended to be a standalone business application**.
+
+Instead, it provides the runtime used by applications and modules.
+
+For example:
+
+```text
+djangospice_framework
+    │
+    ├── billing
+    ├── notification
+    ├── workflow
+    ├── documents
+    ├── helpdesk
+    ├── CRM
+    ├── workforce
+```
+
+Each application can depend on the common runtime while retaining responsibility for its own domain.
+
+This keeps domain logic out of the framework.
+
+---
+
+# Example
+
+A module can build its domain logic on top of djangospice_framework:
+
+```python
+from djangospice_framework.db.models import BaseModel
+
+
+class Invoice(BaseModel):
+    number = models.CharField(max_length=50, unique=True)
+    amount = models.DecimalField(
+        max_digits=12,
+        decimal_places=2,
+    )
+```
+
+The module can then use other djangospice_framework infrastructure for events, notifications, UI, HTTP responses, tables, files, and other common functionality.
+
+The result is a module that contains primarily **business/domain logic**, rather than infrastructure boilerplate.
+
+---
+
+# License
+
+This package is licensed under the **MIT License**.
+
+See [LICENSE](LICENSE) for the full license text.

djangospice_framework-0.1.0/README.md

@@ -0,0 +1,208 @@
+# djangospice_framework
+
+**Application Runtime Framework for building Django apps**
+
+`djangospice_framework` is the application runtime for building modular Django applications.
+
+It is designed to provide a consistent foundation for building large Django application ecosystems without repeatedly implementing the same infrastructure in every application.
+
+---
+
+## Why djangospice_framework?
+
+Large Django projects often accumulate infrastructure that gets duplicated across applications.
+
+For example, individual applications may independently implement:
+
+* Base models
+* Event dispatching
+* Job handling
+* File handling
+* Import/export pipelines
+* Realtime broadcasting
+* Common service abstractions
+
+djangospice_framework provides these capabilities as a shared runtime.
+
+This gives applications a common architecture and allows modules to remain focused on their actual domain.
+
+### Design goals
+
+djangospice_framework is designed around several principles:
+
+* **Reusable** — common functionality should be implemented once.
+* **Modular** — functionality should be composed through independent components.
+* **Extensible** — applications should be able to replace or extend framework behavior.
+* **Django-native** — use Django's existing ecosystem rather than reinventing it.
+* **Developer-friendly** — common application infrastructure should require minimal boilerplate.
+
+---
+
+## Installation
+
+Install djangospice_framework from PyPI:
+
+```bash
+pip install djangospice_framework
+```
+
+---
+
+## Basic Usage
+
+Once installed, djangospice_framework components can be imported by Django applications and modules.
+
+For example, using the common model infrastructure:
+
+```python
+from djangospice_framework.db.models import BaseModel
+
+
+class Customer(BaseModel):
+    name = models.CharField(max_length=255)
+```
+
+The exact capabilities available depend on the components being used by the application.
+
+---
+
+# Core Components
+
+djangospice_framework is organized around reusable infrastructure rather than business-domain applications.
+
+## Database and Models
+
+Common Django model abstractions provide a consistent foundation for application models.
+
+```python
+from djangospice_framework.db.models import BaseModel
+```
+
+The database layer is intended to eliminate repetitive model infrastructure while preserving normal Django ORM behavior.
+
+---
+
+## Events
+
+The event system provides a decoupled mechanism for applications to communicate.
+
+Instead of tightly coupling one application component to another, a component can dispatch an event and allow listeners to react to it.
+
+Conceptually:
+
+```text
+Application Action
+       │
+       ▼
+     Event
+       │
+       ├── Listener
+       ├── Listener
+       └── Listener
+```
+
+This allows functionality such as notifications, auditing, integrations, and background processing to be attached without modifying the original application logic.
+
+---
+
+## Broadcasting and Realtime Communication
+
+The runtime provides abstractions for broadcasting application events and data to users or groups.
+
+For example:
+
+```python
+Broadcast.everyone(...)
+```
+
+or:
+
+```python
+Broadcast.user(user, ...)
+```
+
+This infrastructure can be used by applications that need realtime updates through WebSockets or other supported transports.
+
+---
+
+## Async Support
+
+The runtime provides common abstractions for asynchronous application functionality.
+
+This allows modules to use async operations where appropriate while keeping common infrastructure in one place.
+
+---
+
+## Files
+
+djangospice_framework provides common abstractions for file-related functionality, allowing applications to work with files without repeatedly implementing storage and file-handling patterns.
+
+---
+
+## Imports and Exports
+
+Reusable import/export infrastructure allows applications to implement data exchange consistently.
+
+Typical use cases include:
+
+* CSV imports
+* Spreadsheet imports
+* Data exports
+* Bulk operations
+* Integration pipelines
+
+---
+
+# Application Modules
+
+djangospice_framework is **not intended to be a standalone business application**.
+
+Instead, it provides the runtime used by applications and modules.
+
+For example:
+
+```text
+djangospice_framework
+    │
+    ├── billing
+    ├── notification
+    ├── workflow
+    ├── documents
+    ├── helpdesk
+    ├── CRM
+    ├── workforce
+```
+
+Each application can depend on the common runtime while retaining responsibility for its own domain.
+
+This keeps domain logic out of the framework.
+
+---
+
+# Example
+
+A module can build its domain logic on top of djangospice_framework:
+
+```python
+from djangospice_framework.db.models import BaseModel
+
+
+class Invoice(BaseModel):
+    number = models.CharField(max_length=50, unique=True)
+    amount = models.DecimalField(
+        max_digits=12,
+        decimal_places=2,
+    )
+```
+
+The module can then use other djangospice_framework infrastructure for events, notifications, UI, HTTP responses, tables, files, and other common functionality.
+
+The result is a module that contains primarily **business/domain logic**, rather than infrastructure boilerplate.
+
+---
+
+# License
+
+This package is licensed under the **MIT License**.
+
+See [LICENSE](LICENSE) for the full license text.

djangospice_framework-0.1.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["hatchling>=1.24.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "djangospice-framework"
+version = "0.1.0"
+description = "Application Runtime Framework for building Django apps."
+readme = "README.md"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+
+authors = [
+    { name = "Brian Simpokolwe", email = "briansimpokolwe@gmail.com" }
+]
+
+keywords = [
+    "django",
+    "djangospice_framework",
+    "modular",
+    "framework",
+    "runtime"
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Django",
+    "Framework :: Django :: 5",
+    "Framework :: Django :: 6",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Education",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+]
+
+# --- Core Dependencies (Batteries Included) ---
+dependencies = [
+    # Core Framework & API
+    "django>=5.0",
+    "djangorestframework>=3.15",
+    "django-filter>=24.0",
+    "django-tables2>=2.7",
+    "django-model-utils>=4.5",
+    "python-slugify>=8.0",
+    "asgiref>=3.8",
+    "semver>=3.0",
+    "setuptools>=80.9",
+    
+    # Database
+    "psycopg[binary]>=3.1",
+    
+    # Async & WebSockets
+    "channels>=4.1",
+    "channels-redis>=4.2",
+    
+    # Background Task Processing
+    "celery>=5.4",
+    "django-celery-beat>=2.6",
+    
+    # Data Import/Export & Excel Support
+    "django-import-export>=4.2",
+    "tablib[all]>=3.7",
+    "openpyxl>=3.1",
+    
+    # Email Rendering
+    "premailer>=3.10",
+]
+
+# --- Development Tools ---
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-django",
+    "coverage",
+    "black",
+    "isort",
+    "ruff",
+]
+
+[project.urls]
+Homepage = "https://github.com/briansimpo/djangospice_framework"
+Documentation = "https://github.com/briansimpo/djangospice_framework#readme"
+Source = "https://github.com/briansimpo/djangospice_framework"
+Issues = "https://github.com/briansimpo/djangospice_framework/issues"
+
+# --- Hatch Build Configuration ---
+[tool.hatch.build.targets.wheel]
+packages = ["src/djangospice_framework"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src" = ""

djangospice_framework-0.1.0/src/djangospice_framework/apps/__init__.py

@@ -0,0 +1,9 @@
+from .bootstrap import Bootstrap
+from .config import AppConfig
+from .registry import registry
+
+__all__ = [
+    "Bootstrap",
+    "AppConfig",
+    "registry",
+]