cuz-toolkit 0.1.0__py3-none-any.whl

cuz_toolkit-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,35 @@
+toolkit/__init__.py,sha256=o-0gvX7PpNFBRoYunG6NjRmDMLvkI52SsWm5KHHkr08,488
+toolkit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+toolkit/pytest_plugin.py,sha256=0r8p_-7dDakPBrtAuAeP4j0F7j4S2-I--DYV9OjHvOw,4555
+toolkit/admin/__init__.py,sha256=eVqZ4v2NUZzK9AHfHk5zi9gu77O2orSGOZLKLYSikjM,923
+toolkit/admin/mixins.py,sha256=1cDV2Hyz4kMvTRu2amem3N2h-hCFcMkqm7eTv7gSZfo,19483
+toolkit/ecpay/__init__.py,sha256=JBCxHh91_yWO5doh_ziNqDvH4EyEiWIDuVRTwi1ZkXI,1545
+toolkit/ecpay/client.py,sha256=i8gPeruSoMm77WxXUdkYNZqpqzNr_PQdt2S3B9nzgKA,5738
+toolkit/ecpay/constants.py,sha256=4avwiS1ZO9EE5X9oj-iGOjbDqY7rzDC8SN3XbC_xP8M,3059
+toolkit/testing/__init__.py,sha256=Ec6mU7QQpMJraW9PZHZ_VP2tjsIZE26CmwQ-dS9DABA,458
+toolkit/testing/db.py,sha256=jbRHf0EdqWBaxJDqvkZd3dSoDoreIbPR04L7eCbNXXw,2241
+toolkit/tw_address/__init__.py,sha256=w1o8KpI_qBxtbE6qBN0uJuYWSKaTpmXI_I3EFSWjNMw,1117
+toolkit/tw_address/apps.py,sha256=mwjoantAX535pMh_v-eXCxapZYta0IXK5RClD1CoaFk,555
+toolkit/tw_address/static/toolkit/js/tw-city-admin.js,sha256=zcTI4PJyn4qKXURd1LBIK3LHCwa9yOnrra_wYot9wVA,18060
+toolkit/tw_address/static/toolkit/js/tw-city-selector.min.js,sha256=hZYD69DCuACzSTM46JaQmmUGaGACVGasofM9IWItwdo,27129
+toolkit/tw_banks/__init__.py,sha256=dHbpAFtNLaPk12c1DJYh8eNqibLJhvUiTiMCkfVX-5U,1902
+toolkit/tw_banks/data.json,sha256=hZBSgVxMs-xuuXk6gc84KUg87cjHoNFEvMErPpt0jL4,5034
+toolkit/unfold/__init__.py,sha256=k96xa2MR4umsmKCsWA87t3-f9kKUFDjL7CeZuxeAnNk,423
+toolkit/unfold/apps.py,sha256=xAqdMP-Dk0Xo_mbnWqpihW3lDzoiqZBTgP6h6C-CA8w,1719
+toolkit/unfold/conf.py,sha256=aObQH8x3MsEXqCnevCWfVZ-MneOaVKBTj-wRNNpk0pw,1811
+toolkit/unfold/urls.py,sha256=XRKgWIH_Ux_MhDjoLozP11wuZfUPttk0lMK14L-32PA,305
+toolkit/unfold/views.py,sha256=Arq4xA5xyXMz_bPtsnLTAchfcYUQHx88VtW4iwBWa2A,1462
+toolkit/unfold/widgets.py,sha256=qQc1nAVSJQHZI4fZ2bimh66P4kamKcE3-rRsmJTYaN0,466
+toolkit/unfold/locale/zh_Hant/LC_MESSAGES/django.mo,sha256=rTwLXMlyGC92KeGBbTIpN15WJehSfnqJ38LcKQTdHSk,1033
+toolkit/unfold/locale/zh_Hant/LC_MESSAGES/django.po,sha256=wkJ03idAzUGjrO1lfrc6zzj-nC-uBfSTeSuV1KWv-sk,2191
+toolkit/unfold/locale_unfold/zh_Hant/LC_MESSAGES/django.mo,sha256=weXhzpnPlA4P5IFPHY7C-8Rm4yJaEP7u0FOvX0LJdTA,13309
+toolkit/unfold/locale_unfold/zh_Hant/LC_MESSAGES/django.po,sha256=0NUGfGeG6Y-V6Xknm-wF21stwbNEGLuV2uZkL-GaRHE,33157
+toolkit/unfold/static/toolkit/unfold/css/trix.css,sha256=HF78kjrIwTDHfd6RJN70_J5XaY79g4WklkbZ0GQqJ8w,105
+toolkit/unfold/static/toolkit/unfold/js/trix-upload.js,sha256=Vu3o0CD295Gz2Q84eNatNX3LQypEJjPl1gP1iqlo910,2239
+toolkit/unfold/templates/unfold/forms/helpers/toolbar.html,sha256=yN5DcidbsKnHL7q-stUxkGY8QCBANlPntHWGH78b5xM,10897
+toolkit/utils/__init__.py,sha256=4O7REA-iPEYrCKyY7wmTib7Jxoyw8k_Wm9_CbjIzEZU,120
+toolkit/utils/upload.py,sha256=8pzQuh_CATgNUM-KFRcTBGnB0yfOaH8pK9VQgba184g,2025
+cuz_toolkit-0.1.0.dist-info/METADATA,sha256=vxwWi6_0YIzM6t-N1M2E3r1-DBt33Ggyu6nvDLrVf5c,4607
+cuz_toolkit-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+cuz_toolkit-0.1.0.dist-info/entry_points.txt,sha256=kqLGjnbYkJ0MtFMU3EhbZY7eULRzhDsShaeqb6lYuGU,47
+cuz_toolkit-0.1.0.dist-info/RECORD,,

cuz_toolkit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

cuz_toolkit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+cuz_toolkit = toolkit.pytest_plugin

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

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",
+]