django-cotton-gallery
Drop-in playground for your django-cotton components — annotate them once with @prop comments and get a live, themable, copy-and-paste gallery with auto-generated controls, a lint report, and an insights dashboard.
📚 Docs: https://velezanthony.github.io/django-cotton-gallery/
Install (≈60 seconds)
The gallery is a development-only tool, so the recommended install is as a dev dependency with uv — that way it never ships to production (uv sync --no-dev leaves it out):
uv add --dev django-cotton-gallery
Prefer pip? That works just as well:
pip install django-cotton-gallery
# settings.py
INSTALLED_APPS = [
# ...
"django_cotton", # already there if cotton is set up
"django_cotton_gallery",
]
# urls.py
from django.conf import settings
from django.urls import include, path
urlpatterns = [...]
# Gate it — the gallery exposes component source code. Do NOT ship to prod.
if settings.DEBUG:
urlpatterns += [path("", include("django_cotton_gallery.urls"))]
Run your server and open http://localhost:8000/django-cotton-gallery/. That's it — the gallery indexes whatever cotton already finds. The empty state walks you through your first component if the catalog is empty.
Need production access patterns (staff-only, feature flags), asset injection, or per-setting reference? → Getting started · Configuration
What you get
Live playground — every component renders with auto-generated controls from your @prop annotations. Tweak any prop in real time, copy the tag, done.
Lint report — three severity tiers (errors, warnings, hints) for @prop/<c-vars> mismatches, missing descriptions, and undeclared variables. The same engine runs in CI as python manage.py cotton_lint.
Insights dashboard — config health, annotation coverage, zombie components, most-referenced ranking. Spot rot before it ships.
Ctrl+K switcher with structured filters (prop:size, slot:actions, accepts-attrs, has-named-slots, deprecated) — find any component without leaving the keyboard.
Plus: a refactor planner (transitive dependency tree), an annotation builder (form-based @prop editor), a side-by-side compare view, and i18n chrome (English, Spanish, Basque, French). → Full feature tour
Compatibility
| Versions | |
|---|---|
| Python | 3.10 · 3.11 · 3.12 · 3.13 |
| Django | 4.2 LTS · 5.0 · 5.1 · 5.2 LTS · 6.0 |
| i18n | English (default) · Spanish · Basque · French |
CI verifies every valid Python × Django combination on every push (plus Windows + macOS smoke tests).
Contributing & local development
Clone, then make dev && make serve to run the bundled demo at http://localhost:8000/django-cotton-gallery/. Everything else — repo layout, tests, the Python × Django matrix, i18n, releases — lives in docs/contributors/. See also CONTRIBUTING.md and the CHANGELOG.
Support
If this project saves you time, consider sponsoring its development. It helps keep it maintained.
License
MIT — see LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_cotton_gallery-1.0.0.tar.gz.
File metadata
- Download URL: django_cotton_gallery-1.0.0.tar.gz
- Upload date:
- Size: 437.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1a4d430b7c84d563b7a6507ace299af71852a4ef497984a03ff0355696f0451b
|
|
| MD5 |
7b2bc3e00b77efb46e7642d326d97e6f
|
|
| BLAKE2b-256 |
47d136e049c71d1867650e762229a9c3466f97feda82f6092011142c5a67a59a
|
Provenance
The following attestation bundles were made for django_cotton_gallery-1.0.0.tar.gz:
Publisher:
release.yml on velezanthony/django-cotton-gallery
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_cotton_gallery-1.0.0.tar.gz -
Subject digest:
1a4d430b7c84d563b7a6507ace299af71852a4ef497984a03ff0355696f0451b - Sigstore transparency entry: 2809857391
- Sigstore integration time:
-
Permalink:
velezanthony/django-cotton-gallery@453a33b1f72afe5c758b0ea619601f8b3a2d2284 -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/velezanthony
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@453a33b1f72afe5c758b0ea619601f8b3a2d2284 -
Trigger Event:
push
-
Statement type:
File details
Details for the file django_cotton_gallery-1.0.0-py3-none-any.whl.
File metadata
- Download URL: django_cotton_gallery-1.0.0-py3-none-any.whl
- Upload date:
- Size: 492.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6bb4813a1c3cb6db054886a1e26c6ab35bb1c9bcc897fbdb9e10f0f4ddcdf125
|
|
| MD5 |
091d06424de3be7722c421d26172e30f
|
|
| BLAKE2b-256 |
49b6f0b47cdf50f75fd8cbf2edbbc421d0cc28b1d801a29a15d404c26125ce9d
|
Provenance
The following attestation bundles were made for django_cotton_gallery-1.0.0-py3-none-any.whl:
Publisher:
release.yml on velezanthony/django-cotton-gallery
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_cotton_gallery-1.0.0-py3-none-any.whl -
Subject digest:
6bb4813a1c3cb6db054886a1e26c6ab35bb1c9bcc897fbdb9e10f0f4ddcdf125 - Sigstore transparency entry: 2809857449
- Sigstore integration time:
-
Permalink:
velezanthony/django-cotton-gallery@453a33b1f72afe5c758b0ea619601f8b3a2d2284 -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/velezanthony
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@453a33b1f72afe5c758b0ea619601f8b3a2d2284 -
Trigger Event:
push
-
Statement type:
