django-icv-core 0.1.0__tar.gz

django_icv_core-0.1.0/LICENSE

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

django_icv_core-0.1.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: django-icv-core
+Version: 0.1.0
+Summary: Foundation layer for ICV-Django: abstract base models, managers, middleware, utilities, and audit logging.
+Author: Nigel Copley
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/nigelcopley/icv-django
+Project-URL: Documentation, https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core
+Project-URL: Changelog, https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core/CHANGELOG.md
+Project-URL: Issue Tracker, https://github.com/nigelcopley/icv-django/issues
+Project-URL: Source Code, https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core
+Keywords: django,reusable,base-models,uuid,soft-delete,audit,timestamps
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-django>=4.8; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: factory-boy>=3.3; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: django-stubs>=5.0; extra == "dev"
+Dynamic: license-file
+
+# django-icv-core
+
+[![CI](https://github.com/nigelcopley/icv-django/actions/workflows/ci.yml/badge.svg)](https://github.com/nigelcopley/icv-django/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![Django versions](https://img.shields.io/pypi/djversions/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Foundation layer for ICV-Django packages. Provides abstract base models,
+custom managers, middleware, utilities, template tags, and an optional audit
+subsystem.
+
+## Installation
+
+```bash
+pip install django-icv-core
+```
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "icv_core",
+]
+```
+
+## Documentation
+
+See [APP-001: Core](../../docs/specs/APP-001-core.md) for the full specification.
+
+## Quick Start
+
+```python
+from icv_core.models import BaseModel, SoftDeleteModel
+
+class Article(BaseModel):
+    title = models.CharField(max_length=255)
+
+class Product(SoftDeleteModel):
+    name = models.CharField(max_length=255)
+
+# Soft delete
+product.soft_delete()   # sets is_active=False, deleted_at=now
+product.restore()       # sets is_active=True, deleted_at=None
+
+# Filtered queries
+Product.objects.all()          # active only
+Product.objects.deleted()      # soft-deleted only
+Product.all_objects.all()      # everything
+```
+
+## Settings
+
+All settings use the `ICV_CORE_` prefix. Every setting has a sensible default.
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `ICV_CORE_UUID_VERSION` | `4` | UUID version for primary keys |
+| `ICV_CORE_ALLOW_HARD_DELETE` | `False` | Allow `.delete()` on SoftDeleteModel |
+| `ICV_CORE_TRACK_CREATED_BY` | `False` | Enable created_by/updated_by tracking |
+| `ICV_CORE_AUDIT_ENABLED` | `False` | Enable the audit subsystem |
+| `ICV_CORE_AUDIT_RETENTION_DAYS` | `365` | Days before audit entries are eligible for archival |
+
+See [APP-001](../../docs/specs/APP-001-core.md) Section 2 for the full settings reference.

django_icv_core-0.1.0/README.md

@@ -0,0 +1,63 @@
+# django-icv-core
+
+[![CI](https://github.com/nigelcopley/icv-django/actions/workflows/ci.yml/badge.svg)](https://github.com/nigelcopley/icv-django/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![Django versions](https://img.shields.io/pypi/djversions/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Foundation layer for ICV-Django packages. Provides abstract base models,
+custom managers, middleware, utilities, template tags, and an optional audit
+subsystem.
+
+## Installation
+
+```bash
+pip install django-icv-core
+```
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "icv_core",
+]
+```
+
+## Documentation
+
+See [APP-001: Core](../../docs/specs/APP-001-core.md) for the full specification.
+
+## Quick Start
+
+```python
+from icv_core.models import BaseModel, SoftDeleteModel
+
+class Article(BaseModel):
+    title = models.CharField(max_length=255)
+
+class Product(SoftDeleteModel):
+    name = models.CharField(max_length=255)
+
+# Soft delete
+product.soft_delete()   # sets is_active=False, deleted_at=now
+product.restore()       # sets is_active=True, deleted_at=None
+
+# Filtered queries
+Product.objects.all()          # active only
+Product.objects.deleted()      # soft-deleted only
+Product.all_objects.all()      # everything
+```
+
+## Settings
+
+All settings use the `ICV_CORE_` prefix. Every setting has a sensible default.
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `ICV_CORE_UUID_VERSION` | `4` | UUID version for primary keys |
+| `ICV_CORE_ALLOW_HARD_DELETE` | `False` | Allow `.delete()` on SoftDeleteModel |
+| `ICV_CORE_TRACK_CREATED_BY` | `False` | Enable created_by/updated_by tracking |
+| `ICV_CORE_AUDIT_ENABLED` | `False` | Enable the audit subsystem |
+| `ICV_CORE_AUDIT_RETENTION_DAYS` | `365` | Days before audit entries are eligible for archival |
+
+See [APP-001](../../docs/specs/APP-001-core.md) Section 2 for the full settings reference.

django_icv_core-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django-icv-core"
+version = "0.1.0"
+description = "Foundation layer for ICV-Django: abstract base models, managers, middleware, utilities, and audit logging."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [
+    {name = "Nigel Copley"},
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: Django",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Framework :: Django :: 5.1",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+keywords = [
+    "django",
+    "reusable",
+    "base-models",
+    "uuid",
+    "soft-delete",
+    "audit",
+    "timestamps",
+]
+dependencies = [
+    "Django>=4.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/nigelcopley/icv-django"
+Documentation = "https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core"
+Changelog = "https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core/CHANGELOG.md"
+"Issue Tracker" = "https://github.com/nigelcopley/icv-django/issues"
+"Source Code" = "https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-django>=4.8",
+    "pytest-cov>=5.0",
+    "factory-boy>=3.3",
+    "ruff>=0.5.0",
+    "mypy>=1.10",
+    "django-stubs>=5.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# pytest config is centralised in the root pyproject.toml.
+# Run tests from the project root: pytest packages/icv-core/tests/
+
+# ruff config is centralised in the root pyproject.toml.
+
+[tool.mypy]
+python_version = "3.11"
+plugins = ["mypy_django_plugin.main"]
+strict = false
+
+[tool.django-stubs]
+django_settings_module = "tests.settings"
+
+[tool.coverage.run]
+source = ["src"]
+omit = ["*/migrations/*", "*/testing/*"]
+
+[tool.coverage.report]
+fail_under = 90

django_icv_core-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_icv_core-0.1.0/src/django_icv_core.egg-info/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: django-icv-core
+Version: 0.1.0
+Summary: Foundation layer for ICV-Django: abstract base models, managers, middleware, utilities, and audit logging.
+Author: Nigel Copley
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/nigelcopley/icv-django
+Project-URL: Documentation, https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core
+Project-URL: Changelog, https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core/CHANGELOG.md
+Project-URL: Issue Tracker, https://github.com/nigelcopley/icv-django/issues
+Project-URL: Source Code, https://github.com/nigelcopley/icv-django/tree/main/packages/icv-core
+Keywords: django,reusable,base-models,uuid,soft-delete,audit,timestamps
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-django>=4.8; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: factory-boy>=3.3; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: django-stubs>=5.0; extra == "dev"
+Dynamic: license-file
+
+# django-icv-core
+
+[![CI](https://github.com/nigelcopley/icv-django/actions/workflows/ci.yml/badge.svg)](https://github.com/nigelcopley/icv-django/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![Django versions](https://img.shields.io/pypi/djversions/django-icv-core.svg)](https://pypi.org/project/django-icv-core/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Foundation layer for ICV-Django packages. Provides abstract base models,
+custom managers, middleware, utilities, template tags, and an optional audit
+subsystem.
+
+## Installation
+
+```bash
+pip install django-icv-core
+```
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "icv_core",
+]
+```
+
+## Documentation
+
+See [APP-001: Core](../../docs/specs/APP-001-core.md) for the full specification.
+
+## Quick Start
+
+```python
+from icv_core.models import BaseModel, SoftDeleteModel
+
+class Article(BaseModel):
+    title = models.CharField(max_length=255)
+
+class Product(SoftDeleteModel):
+    name = models.CharField(max_length=255)
+
+# Soft delete
+product.soft_delete()   # sets is_active=False, deleted_at=now
+product.restore()       # sets is_active=True, deleted_at=None
+
+# Filtered queries
+Product.objects.all()          # active only
+Product.objects.deleted()      # soft-deleted only
+Product.all_objects.all()      # everything
+```
+
+## Settings
+
+All settings use the `ICV_CORE_` prefix. Every setting has a sensible default.
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `ICV_CORE_UUID_VERSION` | `4` | UUID version for primary keys |
+| `ICV_CORE_ALLOW_HARD_DELETE` | `False` | Allow `.delete()` on SoftDeleteModel |
+| `ICV_CORE_TRACK_CREATED_BY` | `False` | Enable created_by/updated_by tracking |
+| `ICV_CORE_AUDIT_ENABLED` | `False` | Enable the audit subsystem |
+| `ICV_CORE_AUDIT_RETENTION_DAYS` | `365` | Days before audit entries are eligible for archival |
+
+See [APP-001](../../docs/specs/APP-001-core.md) Section 2 for the full settings reference.

django_icv_core-0.1.0/src/django_icv_core.egg-info/SOURCES.txt

@@ -0,0 +1,67 @@
+LICENSE
+README.md
+pyproject.toml
+src/django_icv_core.egg-info/PKG-INFO
+src/django_icv_core.egg-info/SOURCES.txt
+src/django_icv_core.egg-info/dependency_links.txt
+src/django_icv_core.egg-info/requires.txt
+src/django_icv_core.egg-info/top_level.txt
+src/icv_core/__init__.py
+src/icv_core/admin.py
+src/icv_core/apps.py
+src/icv_core/checks.py
+src/icv_core/conf.py
+src/icv_core/exceptions.py
+src/icv_core/handlers.py
+src/icv_core/middleware.py
+src/icv_core/py.typed
+src/icv_core/signals.py
+src/icv_core/audit/__init__.py
+src/icv_core/audit/decorators.py
+src/icv_core/audit/handlers.py
+src/icv_core/audit/middleware.py
+src/icv_core/audit/mixins.py
+src/icv_core/audit/models.py
+src/icv_core/audit/services.py
+src/icv_core/audit/signals.py
+src/icv_core/audit/tasks.py
+src/icv_core/audit/api/__init__.py
+src/icv_core/audit/api/serializers.py
+src/icv_core/audit/api/urls.py
+src/icv_core/audit/api/views.py
+src/icv_core/management/__init__.py
+src/icv_core/management/commands/__init__.py
+src/icv_core/management/commands/icv_core_audit_archive.py
+src/icv_core/management/commands/icv_core_audit_stats.py
+src/icv_core/management/commands/icv_core_check.py
+src/icv_core/managers/__init__.py
+src/icv_core/managers/scoped.py
+src/icv_core/managers/soft_delete.py
+src/icv_core/migrations/0001_initial.py
+src/icv_core/migrations/__init__.py
+src/icv_core/models/__init__.py
+src/icv_core/models/base.py
+src/icv_core/models/compliance.py
+src/icv_core/models/soft_delete.py
+src/icv_core/services/__init__.py
+src/icv_core/templatetags/__init__.py
+src/icv_core/templatetags/icv_core.py
+src/icv_core/tenancy/__init__.py
+src/icv_core/tenancy/context.py
+src/icv_core/tenancy/managers.py
+src/icv_core/tenancy/mixins.py
+src/icv_core/testing/__init__.py
+src/icv_core/testing/factories.py
+src/icv_core/testing/fixtures.py
+src/icv_core/testing/helpers.py
+tests/test_audit_api.py
+tests/test_audit_features.py
+tests/test_audit_services.py
+tests/test_commands_and_checks.py
+tests/test_conf.py
+tests/test_managers.py
+tests/test_middleware.py
+tests/test_models.py
+tests/test_signals.py
+tests/test_templatetags.py
+tests/test_tenancy.py

django_icv_core-0.1.0/src/django_icv_core.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_icv_core-0.1.0/src/django_icv_core.egg-info/requires.txt

@@ -0,0 +1,10 @@
+Django>=4.2
+
+[dev]
+pytest>=8.0
+pytest-django>=4.8
+pytest-cov>=5.0
+factory-boy>=3.3
+ruff>=0.5.0
+mypy>=1.10
+django-stubs>=5.0

django_icv_core-0.1.0/src/django_icv_core.egg-info/top_level.txt

@@ -0,0 +1 @@
+icv_core

django_icv_core-0.1.0/src/icv_core/__init__.py

@@ -0,0 +1,10 @@
+"""
+icv-core — Foundation layer for ICV-Django packages.
+
+Provides abstract base models, custom managers, middleware, utilities,
+template tags, and an optional audit subsystem.
+"""
+
+__version__ = "0.1.0"
+
+default_app_config = "icv_core.apps.IcvCoreConfig"

django_icv_core-0.1.0/src/icv_core/admin.py

@@ -0,0 +1,41 @@
+"""Admin configuration for icv-core.
+
+No concrete models in the core layer. Provides IcvSoftDeleteAdmin mixin
+for consuming projects.
+"""
+
+from django.contrib import admin
+from django.utils.translation import gettext_lazy as _
+
+
+class IcvSoftDeleteAdmin(admin.ModelAdmin):
+    """
+    Admin mixin for SoftDeleteModel subclasses.
+
+    Includes soft-deleted records in the admin queryset and provides
+    restore/soft-delete bulk actions.
+
+    Usage::
+
+        @admin.register(MyModel)
+        class MyModelAdmin(IcvSoftDeleteAdmin):
+            ...
+    """
+
+    list_filter = ("is_active",)
+
+    def get_queryset(self, request):
+        """Include soft-deleted records in the admin list."""
+        return self.model.all_objects.all()
+
+    actions = ["soft_delete_selected", "restore_selected"]
+
+    @admin.action(description=_("Soft-delete selected records"))
+    def soft_delete_selected(self, request, queryset) -> None:
+        for obj in queryset.filter(is_active=True):
+            obj.soft_delete()
+
+    @admin.action(description=_("Restore selected records"))
+    def restore_selected(self, request, queryset) -> None:
+        for obj in queryset.filter(is_active=False):
+            obj.restore()

django_icv_core-0.1.0/src/icv_core/apps.py

@@ -0,0 +1,20 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class IcvCoreConfig(AppConfig):
+    name = "icv_core"
+    label = "icv_core"
+    verbose_name = _("ICV Core")
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def ready(self) -> None:
+        from icv_core.conf import ICV_CORE_AUDIT_ENABLED
+
+        from . import (
+            checks,  # noqa: F401 — register system checks
+            handlers,  # noqa: F401 — connect signal handlers
+        )
+
+        if ICV_CORE_AUDIT_ENABLED:
+            from icv_core.audit import handlers as audit_handlers  # noqa: F401

django_icv_core-0.1.0/src/icv_core/audit/__init__.py

@@ -0,0 +1,12 @@
+"""
+icv_core.audit — Audit subsystem for icv-core.
+
+Active only when ICV_CORE_AUDIT_ENABLED=True. Provides:
+- AuditEntry, AdminActivityLog, SystemAlert concrete models
+- AuditMixin for automatic model change tracking
+- AuditRequestMiddleware for request context capture
+- log_event() service function
+- @audited decorator
+- Celery task for archiving old entries
+- DRF API viewsets (admin-only)
+"""

django_icv_core-0.1.0/src/icv_core/audit/api/serializers.py

@@ -0,0 +1,69 @@
+"""DRF serializers for the audit subsystem."""
+
+from rest_framework import serializers
+
+from icv_core.audit.models import AdminActivityLog, AuditEntry, SystemAlert
+
+
+class AuditEntrySerializer(serializers.ModelSerializer):
+    class Meta:
+        model = AuditEntry
+        fields = [
+            "id",
+            "event_type",
+            "action",
+            "user",
+            "ip_address",
+            "user_agent",
+            "target_content_type",
+            "target_object_id",
+            "description",
+            "metadata",
+            "created_at",
+        ]
+        read_only_fields = fields
+
+
+class AdminActivityLogSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = AdminActivityLog
+        fields = [
+            "id",
+            "admin_user",
+            "action_type",
+            "description",
+            "target_content_type",
+            "target_object_id",
+            "ip_address",
+            "user_agent",
+            "metadata",
+            "created_at",
+        ]
+        read_only_fields = fields
+
+
+class SystemAlertSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = SystemAlert
+        fields = [
+            "id",
+            "alert_type",
+            "severity",
+            "title",
+            "message",
+            "metadata",
+            "is_resolved",
+            "resolved_by",
+            "resolved_at",
+            "resolution_notes",
+            "created_at",
+            "updated_at",
+        ]
+        read_only_fields = [
+            "id",
+            "is_resolved",
+            "resolved_by",
+            "resolved_at",
+            "created_at",
+            "updated_at",
+        ]

django_icv_core-0.1.0/src/icv_core/audit/api/urls.py

@@ -0,0 +1,12 @@
+"""URL configuration for the icv-core audit API."""
+
+from rest_framework.routers import DefaultRouter
+
+from icv_core.audit.api.views import AdminActivityLogViewSet, AuditEntryViewSet, SystemAlertViewSet
+
+router = DefaultRouter()
+router.register(r"entries", AuditEntryViewSet, basename="audit-entry")
+router.register(r"admin-activity", AdminActivityLogViewSet, basename="audit-admin-activity")
+router.register(r"alerts", SystemAlertViewSet, basename="audit-alert")
+
+urlpatterns = router.urls