cuz-toolkit 0.1.0__tar.gz

cuz_toolkit-0.1.0/.claude/settings.local.json

@@ -0,0 +1,19 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv run pip show:*)",
+      "Bash(find:*)",
+      "Bash(uv run pytest:*)",
+      "Skill(lint-all)",
+      "Bash(uv run mypy:*)",
+      "Bash(uv run ruff check:*)",
+      "Bash(uv run ruff:*)",
+      "Bash(uv run python:*)",
+      "Bash(git rev-parse:*)",
+      "Bash(ls:*)",
+      "Bash(uv run:*)",
+      "Bash(uv pip:*)",
+      "Bash(cd:*)"
+    ]
+  }
+}

cuz_toolkit-0.1.0/.gitignore

@@ -0,0 +1,42 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment files
+.env
+.env.*
+!.env.example
+
+# Django
+*.log
+db.sqlite3
+db.sqlite3-journal
+**/media/*
+!**/media/.gitkeep
+staticfiles/
+
+# IDE
+.vscode/
+.idea/
+
+# OS
+.DS_Store
+
+# Cache
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+review-cache/
+
+# Coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml

cuz_toolkit-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.19.1
+    hooks:
+      - id: mypy
+        entry: bash -c 'export MYPYPATH=src && mypy --config=pyproject.toml --install-types --non-interactive --show-traceback .'
+        pass_filenames: false
+        language: system
+
+  - repo: https://github.com/PyCQA/bandit
+    rev: "1.9.3"
+    hooks:
+      - id: bandit
+        args: ["-c", "pyproject.toml", "-r", "."]
+        additional_dependencies: ["bandit[toml]"]

cuz_toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: cuz-toolkit
+Version: 0.1.0
+Summary: A collection of Django utilities: Admin mixins, testing helpers, and common patterns
+Project-URL: Homepage, https://github.com/froggen/django-toolkit
+Project-URL: Repository, https://github.com/froggen/django-toolkit
+Author-email: Ivan <iven12345678900@gmail.com>
+License: MIT
+Keywords: admin,django,mixin,permission,testing,toolkit
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+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.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.13
+Requires-Dist: django>=4.0
+Provides-Extra: unfold
+Requires-Dist: django-unfold>=0.85.0; extra == 'unfold'
+Description-Content-Type: text/markdown
+
+# Django Toolkit
+
+A collection of Django utilities: Admin mixins, testing helpers, and common patterns.
+
+## Installation
+
+```bash
+# From GitHub
+uv add git+https://github.com/froggen/django-toolkit.git
+
+# Local development
+uv add --editable ../django-toolkit
+```
+
+## Modules
+
+### toolkit.admin - Admin Mixins
+
+```python
+from django.contrib import admin
+from toolkit.admin import OwnerMixin, ReadOnlyMixin
+from unfold.admin import ModelAdmin
+
+@admin.register(Project)
+class ProjectAdmin(OwnerMixin, ModelAdmin):
+    owner_field = "user"  # Users can only edit their own projects
+```
+
+### toolkit.testing - Testing Utilities
+
+```python
+from toolkit.testing import has_index_on_columns, get_table_constraints
+
+# Verify database indexes exist
+def test_status_index_exists():
+    assert has_index_on_columns("invoice", ["status", "created_at"])
+```
+
+## Available Admin Mixins
+
+### Permission Control
+
+| Mixin | Description |
+|-------|-------------|
+| `SuperuserOnlyMixin` | Only superusers can access |
+| `ReadOnlyMixin` | No add/change/delete, view only |
+| `CRUDMixin` | Basic CRUD for active users |
+| `OwnerMixin` | Users can only access their own data |
+| `ReadOnlyOwnerMixin` | View-only for owned data |
+
+### Special Patterns
+
+| Mixin | Description |
+|-------|-------------|
+| `ActionsOnlyMixin` | Hide save buttons, use actions only |
+| `SingleObjectMixin` | Redirect to edit/add page (for one-per-user models) |
+
+### Inline Mixins
+
+| Mixin | Description |
+|-------|-------------|
+| `InlineCRUDMixin` | CRUD for inline models |
+| `ReadOnlyInlineMixin` | Read-only inline |
+
+### UI Helpers
+
+| Mixin | Description |
+|-------|-------------|
+| `HideRelatedFieldButtonsMixin` | Hide add/edit/delete buttons on FK fields |
+
+## Testing Utilities
+
+| Function | Description |
+|----------|-------------|
+| `get_table_constraints(table_name)` | Get all constraints and indexes for a table |
+| `has_index_on_columns(table_name, columns)` | Check if an index exists on specified columns |
+
+## Usage Examples
+
+### Owner-based Permission
+
+```python
+@admin.register(Article)
+class ArticleAdmin(OwnerMixin, ModelAdmin):
+    owner_field = "author"
+    list_display = ["title", "author", "created_at"]
+```
+
+### Nested Owner Field
+
+```python
+@admin.register(Comment)
+class CommentAdmin(OwnerMixin, ModelAdmin):
+    owner_field = "post__author"  # Comment -> Post -> Author
+```
+
+### Read-only with Owner Filter
+
+```python
+@admin.register(Order)
+class OrderAdmin(ReadOnlyOwnerMixin, ModelAdmin):
+    owner_field = "customer"
+```
+
+### Single Object (e.g., User Profile)
+
+```python
+@admin.register(UserProfile)
+class UserProfileAdmin(SingleObjectMixin, OwnerMixin, ModelAdmin):
+    owner_field = "user"
+```
+
+### Actions Only (e.g., Approval Workflow)
+
+```python
+@admin.register(WithdrawalRequest)
+class WithdrawalRequestAdmin(ActionsOnlyMixin, ModelAdmin):
+    readonly_fields = ["amount", "status", "created_at"]
+    actions_submit_line = ["approve_action", "reject_action"]
+```
+
+### Index Validation in Tests
+
+```python
+import pytest
+from toolkit.testing import has_index_on_columns
+
+@pytest.mark.django_db
+class TestDatabaseIndexes:
+    def test_composite_index_exists(self):
+        assert has_index_on_columns("booking", ["status", "start"])
+
+    def test_single_column_index_exists(self):
+        assert has_index_on_columns("payment", ["transaction_id"])
+```
+
+## License
+
+MIT

cuz_toolkit-0.1.0/README.md

@@ -0,0 +1,139 @@
+# Django Toolkit
+
+A collection of Django utilities: Admin mixins, testing helpers, and common patterns.
+
+## Installation
+
+```bash
+# From GitHub
+uv add git+https://github.com/froggen/django-toolkit.git
+
+# Local development
+uv add --editable ../django-toolkit
+```
+
+## Modules
+
+### toolkit.admin - Admin Mixins
+
+```python
+from django.contrib import admin
+from toolkit.admin import OwnerMixin, ReadOnlyMixin
+from unfold.admin import ModelAdmin
+
+@admin.register(Project)
+class ProjectAdmin(OwnerMixin, ModelAdmin):
+    owner_field = "user"  # Users can only edit their own projects
+```
+
+### toolkit.testing - Testing Utilities
+
+```python
+from toolkit.testing import has_index_on_columns, get_table_constraints
+
+# Verify database indexes exist
+def test_status_index_exists():
+    assert has_index_on_columns("invoice", ["status", "created_at"])
+```
+
+## Available Admin Mixins
+
+### Permission Control
+
+| Mixin | Description |
+|-------|-------------|
+| `SuperuserOnlyMixin` | Only superusers can access |
+| `ReadOnlyMixin` | No add/change/delete, view only |
+| `CRUDMixin` | Basic CRUD for active users |
+| `OwnerMixin` | Users can only access their own data |
+| `ReadOnlyOwnerMixin` | View-only for owned data |
+
+### Special Patterns
+
+| Mixin | Description |
+|-------|-------------|
+| `ActionsOnlyMixin` | Hide save buttons, use actions only |
+| `SingleObjectMixin` | Redirect to edit/add page (for one-per-user models) |
+
+### Inline Mixins
+
+| Mixin | Description |
+|-------|-------------|
+| `InlineCRUDMixin` | CRUD for inline models |
+| `ReadOnlyInlineMixin` | Read-only inline |
+
+### UI Helpers
+
+| Mixin | Description |
+|-------|-------------|
+| `HideRelatedFieldButtonsMixin` | Hide add/edit/delete buttons on FK fields |
+
+## Testing Utilities
+
+| Function | Description |
+|----------|-------------|
+| `get_table_constraints(table_name)` | Get all constraints and indexes for a table |
+| `has_index_on_columns(table_name, columns)` | Check if an index exists on specified columns |
+
+## Usage Examples
+
+### Owner-based Permission
+
+```python
+@admin.register(Article)
+class ArticleAdmin(OwnerMixin, ModelAdmin):
+    owner_field = "author"
+    list_display = ["title", "author", "created_at"]
+```
+
+### Nested Owner Field
+
+```python
+@admin.register(Comment)
+class CommentAdmin(OwnerMixin, ModelAdmin):
+    owner_field = "post__author"  # Comment -> Post -> Author
+```
+
+### Read-only with Owner Filter
+
+```python
+@admin.register(Order)
+class OrderAdmin(ReadOnlyOwnerMixin, ModelAdmin):
+    owner_field = "customer"
+```
+
+### Single Object (e.g., User Profile)
+
+```python
+@admin.register(UserProfile)
+class UserProfileAdmin(SingleObjectMixin, OwnerMixin, ModelAdmin):
+    owner_field = "user"
+```
+
+### Actions Only (e.g., Approval Workflow)
+
+```python
+@admin.register(WithdrawalRequest)
+class WithdrawalRequestAdmin(ActionsOnlyMixin, ModelAdmin):
+    readonly_fields = ["amount", "status", "created_at"]
+    actions_submit_line = ["approve_action", "reject_action"]
+```
+
+### Index Validation in Tests
+
+```python
+import pytest
+from toolkit.testing import has_index_on_columns
+
+@pytest.mark.django_db
+class TestDatabaseIndexes:
+    def test_composite_index_exists(self):
+        assert has_index_on_columns("booking", ["status", "start"])
+
+    def test_single_column_index_exists(self):
+        assert has_index_on_columns("payment", ["transaction_id"])
+```
+
+## License
+
+MIT

cuz_toolkit-0.1.0/pyproject.toml

@@ -0,0 +1,138 @@
+[project]
+name = "cuz-toolkit"
+version = "0.1.0"
+description = "A collection of Django utilities: Admin mixins, testing helpers, and common patterns"
+authors = [
+    {name = "Ivan", email = "iven12345678900@gmail.com"}
+]
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.13"
+dependencies = [
+    "django>=4.0",
+]
+keywords = ["django", "admin", "mixin", "permission", "testing", "toolkit"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 4.0",
+    "Framework :: Django :: 4.1",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Framework :: Django :: 5.1",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/froggen/django-toolkit"
+Repository = "https://github.com/froggen/django-toolkit"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/toolkit"]
+
+[project.entry-points.pytest11]
+cuz_toolkit = "toolkit.pytest_plugin"
+
+[project.optional-dependencies]
+unfold = [
+    "django-unfold>=0.85.0",
+]
+
+[tool.pytest.ini_options]
+addopts = "-s -n auto"
+DJANGO_SETTINGS_MODULE = "tests.settings"
+django_find_project = false
+pythonpath = ["."]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+
+[tool.coverage.run]
+source = ["src/toolkit"]
+branch = true
+
+[tool.coverage.report]
+omit = ["tests/*"]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 120
+src = ["src"]
+exclude = [
+    "**/migrations/*.py",
+]
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes
+    "I",      # isort
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "UP",     # pyupgrade
+    "SIM",    # flake8-simplify
+    "PTH",    # flake8-use-pathlib
+    "RUF",    # ruff-specific rules
+    "DJ",     # flake8-django
+]
+ignore = ["E501", "RUF012"]
+allowed-confusables = ["：", "，", "（", "）", "？", "、", "「", "」", "。"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.mypy]
+plugins = ["mypy_django_plugin.main"]
+python_version = "3.13"
+strict = true
+allow_redefinition = true
+exclude = [
+    ".*/migrations/.*",
+]
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+disable_error_code = ["type-arg", "assignment", "misc", "call-arg", "attr-defined"]
+
+[[tool.mypy.overrides]]
+module = "unfold.*"
+ignore_missing_imports = true
+
+[tool.django-stubs]
+django_settings_module = "tests.settings"
+
+[tool.bandit]
+exclude_dirs = ["tests", "venv", ".venv", "conftest.py"]
+
+[dependency-groups]
+dev = [
+    "bandit>=1.9.3",
+    "django-stubs[compatible-mypy]>=5.2.9",
+    "django-unfold>=0.85.0",
+    "mypy>=1.19.1",
+    "pre-commit>=4.2.0",
+    "pytest>=9.0.2",
+    "pytest-cov>=7.0.0",
+    "pytest-django>=4.11.1",
+    "pytest-xdist>=3.8.0",
+    "ruff>=0.15.0",
+]

cuz_toolkit-0.1.0/src/toolkit/__init__.py

@@ -0,0 +1,12 @@
+"""
+Django Toolkit - A collection of Django utilities for common development patterns.
+
+Modules:
+    toolkit.admin - Admin mixins for permission control
+    toolkit.ecpay - ECPay payment gateway integration (signing, verification, constants)
+    toolkit.testing - Testing utilities for database validation
+    toolkit.unfold - Unfold Admin extension (Trix editor image upload)
+    toolkit.utils - Common utilities (UploadToUniquePath, etc.)
+"""
+
+__version__ = "0.1.0"  # pragma: no cover

cuz_toolkit-0.1.0/src/toolkit/admin/__init__.py

@@ -0,0 +1,42 @@
+"""
+Django Admin Mixins - A collection of Django Admin mixins for permission control.
+
+Usage:
+    from toolkit.admin import OwnerMixin, ReadOnlyMixin, CRUDMixin
+
+    @admin.register(MyModel)
+    class MyModelAdmin(OwnerMixin, ModelAdmin):
+        owner_field = "user"
+"""
+
+from toolkit.admin.mixins import (
+    ActionsOnlyMixin,
+    CRUDMixin,
+    EditOnlyInlineMixin,
+    EditOnlyMixin,
+    HideRelatedFieldButtonsMixin,
+    InlineCRUDMixin,
+    OwnerMixin,
+    ReadOnlyInlineMixin,
+    ReadOnlyMixin,
+    ReadOnlyOwnerMixin,
+    SelfOnlyMixin,
+    SingleObjectMixin,
+    SuperuserOnlyMixin,
+)
+
+__all__ = [
+    "ActionsOnlyMixin",
+    "CRUDMixin",
+    "EditOnlyInlineMixin",
+    "EditOnlyMixin",
+    "HideRelatedFieldButtonsMixin",
+    "InlineCRUDMixin",
+    "OwnerMixin",
+    "ReadOnlyInlineMixin",
+    "ReadOnlyMixin",
+    "ReadOnlyOwnerMixin",
+    "SelfOnlyMixin",
+    "SingleObjectMixin",
+    "SuperuserOnlyMixin",
+]