django-guitars 0.1.0__tar.gz

django_guitars-0.1.0/.gitignore

@@ -0,0 +1,252 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Database
+*.db
+*.sqlite3
+/media
+/staticfiles
+
+# Security
+.env.local
+.env.production
+secret_key.txt
+
+# Static files (collected)
+/static/
+/staticfiles/
+
+# Media files
+/media/
+
+# Cache
+*.py[cod]
+
+# Django migrations (optional - team decision)
+# */migrations/*.py
+# */migrations/*.pyc
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+
+.remember/
+.claude/
+
+# Project-local pytest junit output (from addopts --junit-xml)
+.pytest-last.xml

django_guitars-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-06-04
+
+### Added
+
+- `SetarModel` — base abstract model: DB-default `_created_at` / `_updated_at`
+  timestamps, `.update()` / `.aupdate()` helpers, and cached-property
+  invalidation on `refresh_from_db()`.
+- `GuitarModel` — `SetarModel` combined with `SoftDeletableModel`.
+- `SoftDeletableModel` with `LiveManager` / `ArchiveManager` /
+  `AllObjectsManager` — PostgreSQL-enforced soft deletion, cascade soft delete,
+  and `hard_delete()`.
+- `DisableSignals` context manager for temporarily muting Django signals.
+- `makeguitarmigrations` management command — generates the PostgreSQL
+  trigger/rule migrations behind the timestamps and soft deletion.
+
+[0.1.0]: https://github.com/Behnam-RK/django-guitars/releases/tag/v0.1.0

django_guitars-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Behnam RK
+
+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_guitars-0.1.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: django-guitars
+Version: 0.1.0
+Summary: A reusable Django app for cataloging guitars.
+Project-URL: Homepage, https://github.com/Behnam-RK/django-guitars
+Project-URL: Repository, https://github.com/Behnam-RK/django-guitars
+Project-URL: Issues, https://github.com/Behnam-RK/django-guitars/issues
+Project-URL: Changelog, https://github.com/Behnam-RK/django-guitars/blob/main/CHANGELOG.md
+Author-email: Behnam RK <behnam.rk47@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: django,guitars,reusable-app
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: django>=5.0
+Description-Content-Type: text/markdown
+
+# django-guitars
+
+> Django Reinhardt was one of the greatest guitarists who ever lived — so
+> **django-guitars** hands *the other* Django, the web framework, a better set
+> of guitars.
+
+A small, focused collection of **reusable Django utilities**: opinionated base
+models, PostgreSQL-enforced soft deletion, and the helpers that make them work.
+Use only the pieces you need.
+
+[![PyPI version](https://img.shields.io/pypi/v/django-guitars.svg)](https://pypi.org/project/django-guitars/)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-guitars.svg)](https://pypi.org/project/django-guitars/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## Requirements
+
+- **Python** ≥ 3.10
+- **Django** ≥ 5.0 — uses `db_default`
+- **PostgreSQL** — soft deletion and the `updated_at` refresh are enforced by
+  PostgreSQL rules and triggers
+
+## Installation
+
+```bash
+pip install django-guitars
+```
+
+Add the app to your settings:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "guitars",
+]
+```
+
+## What's inside
+
+### Base models
+
+| Base | What you get |
+| --- | --- |
+| `SetarModel` | `_created_at` / `_updated_at` (DB-default `NOW()`; `_updated_at` kept current by a PostgreSQL statement trigger, so it's accurate even for bulk/raw updates), `.update()` / `.aupdate()`, cached-property invalidation on `refresh_from_db()`, and `app_label()` / `model_name()` / `class_name()` helpers |
+| `GuitarModel` | Everything in `SetarModel` **plus** soft deletion (it is `SetarModel` + `SoftDeletableModel`) |
+| `SoftDeletableModel` | Soft deletion on its own |
+
+```python
+from django.db import models
+
+from guitars.models import GuitarModel
+
+
+class Article(GuitarModel):
+    title = models.CharField(max_length=200)
+```
+
+The `.update()` helper sets attributes and saves in one call:
+
+```python
+article.update(title="New title")        # set fields + save (only changed fields)
+article.update(title="x", _save=False)    # change in memory only, no DB write
+await article.aupdate(title="async")      # async variant
+```
+
+### Soft deletion
+
+For models inheriting `SoftDeletableModel` (or `GuitarModel`), `.delete()`
+becomes a **soft delete**: the row stays and `_deleted_at` is set. Because this
+is enforced by a PostgreSQL rule, it holds even for queryset bulk deletes and
+raw SQL. Three managers expose the data:
+
+```python
+Article.objects.all()         # live rows only (the default manager)
+Article._archives.all()       # soft-deleted rows only
+Article._all_objects.all()    # everything
+
+article.delete()              # soft delete — sets _deleted_at
+article.is_deleted            # True
+article.is_alive              # False
+
+# Permanently remove rows (and CASCADE-related rows), bypassing the rule:
+Article._all_objects.filter(...).hard_delete()
+```
+
+Soft-deleting a row also soft-deletes rows related by `on_delete=CASCADE`.
+
+> ⚠️ **Required setup.** The soft-delete rule (and the `updated_at` trigger)
+> live in a migration generated by [`makeguitarmigrations`](#makeguitarmigrations).
+> Until you run that command and `migrate`, **`.delete()` permanently deletes the
+> row** — the protection isn't active yet. Re-run it whenever you add or change a
+> model that uses these bases.
+
+### `makeguitarmigrations`
+
+`makemigrations` does **not** create the triggers and rules — they live in
+separate migrations generated by this command, and this step is **required** for
+soft deletion and the `updated_at` trigger to work. After your usual
+`makemigrations`, run:
+
+```bash
+python manage.py makeguitarmigrations
+```
+
+It scans your **first-party** apps for models with `_updated_at` / `_deleted_at`
+and writes the matching trigger/rule migrations. Tell it which apps are yours:
+
+```python
+# settings.py
+LOCAL_APPS = ["blog", "shop"]      # apps the command scans
+
+# Optional: which app hosts the shared trigger-function migration.
+# Defaults to LOCAL_APPS[0].
+# TRIGGER_FUNCTION_APP = "blog"
+```
+
+Use `--check` in CI to fail when advanced migrations are missing:
+
+```bash
+python manage.py makeguitarmigrations --check
+```
+
+### `DisableSignals`
+
+A context manager that temporarily disconnects Django signals — handy for bulk
+imports or silent saves:
+
+```python
+from django.db.models.signals import post_save
+
+from guitars.signals import DisableSignals
+
+with DisableSignals():                    # all default signals
+    instance.save()                       # nothing fires
+
+with DisableSignals(signals=[post_save]): # only the listed signals
+    instance.save()
+```
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and Docker (for PostgreSQL).
+
+```bash
+uv sync                  # install dependencies + the package (editable)
+docker compose up -d     # start PostgreSQL (skip if you already run one on :5432)
+uv run pytest            # run the test suite
+uv run pytest --cov=guitars --cov-report=term-missing
+```
+
+The test suite defines concrete models in `tests/testapp` (the shipped package
+is abstract-only) and runs against a real PostgreSQL database so the rules and
+triggers are actually exercised.
+
+## License
+
+[MIT](LICENSE) © 2026 Behnam RK
+
+## Why "guitars"?
+
+Django Reinhardt was a legendary jazz guitarist. This package gives the *other*
+Django — the web framework — some better guitars: a grab-bag of utilities that
+make everyday Django a little nicer. The base models keep the theme going with
+`SetarModel` and `GuitarModel`.

django_guitars-0.1.0/README.md

@@ -0,0 +1,163 @@
+# django-guitars
+
+> Django Reinhardt was one of the greatest guitarists who ever lived — so
+> **django-guitars** hands *the other* Django, the web framework, a better set
+> of guitars.
+
+A small, focused collection of **reusable Django utilities**: opinionated base
+models, PostgreSQL-enforced soft deletion, and the helpers that make them work.
+Use only the pieces you need.
+
+[![PyPI version](https://img.shields.io/pypi/v/django-guitars.svg)](https://pypi.org/project/django-guitars/)
+[![Python versions](https://img.shields.io/pypi/pyversions/django-guitars.svg)](https://pypi.org/project/django-guitars/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+## Requirements
+
+- **Python** ≥ 3.10
+- **Django** ≥ 5.0 — uses `db_default`
+- **PostgreSQL** — soft deletion and the `updated_at` refresh are enforced by
+  PostgreSQL rules and triggers
+
+## Installation
+
+```bash
+pip install django-guitars
+```
+
+Add the app to your settings:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "guitars",
+]
+```
+
+## What's inside
+
+### Base models
+
+| Base | What you get |
+| --- | --- |
+| `SetarModel` | `_created_at` / `_updated_at` (DB-default `NOW()`; `_updated_at` kept current by a PostgreSQL statement trigger, so it's accurate even for bulk/raw updates), `.update()` / `.aupdate()`, cached-property invalidation on `refresh_from_db()`, and `app_label()` / `model_name()` / `class_name()` helpers |
+| `GuitarModel` | Everything in `SetarModel` **plus** soft deletion (it is `SetarModel` + `SoftDeletableModel`) |
+| `SoftDeletableModel` | Soft deletion on its own |
+
+```python
+from django.db import models
+
+from guitars.models import GuitarModel
+
+
+class Article(GuitarModel):
+    title = models.CharField(max_length=200)
+```
+
+The `.update()` helper sets attributes and saves in one call:
+
+```python
+article.update(title="New title")        # set fields + save (only changed fields)
+article.update(title="x", _save=False)    # change in memory only, no DB write
+await article.aupdate(title="async")      # async variant
+```
+
+### Soft deletion
+
+For models inheriting `SoftDeletableModel` (or `GuitarModel`), `.delete()`
+becomes a **soft delete**: the row stays and `_deleted_at` is set. Because this
+is enforced by a PostgreSQL rule, it holds even for queryset bulk deletes and
+raw SQL. Three managers expose the data:
+
+```python
+Article.objects.all()         # live rows only (the default manager)
+Article._archives.all()       # soft-deleted rows only
+Article._all_objects.all()    # everything
+
+article.delete()              # soft delete — sets _deleted_at
+article.is_deleted            # True
+article.is_alive              # False
+
+# Permanently remove rows (and CASCADE-related rows), bypassing the rule:
+Article._all_objects.filter(...).hard_delete()
+```
+
+Soft-deleting a row also soft-deletes rows related by `on_delete=CASCADE`.
+
+> ⚠️ **Required setup.** The soft-delete rule (and the `updated_at` trigger)
+> live in a migration generated by [`makeguitarmigrations`](#makeguitarmigrations).
+> Until you run that command and `migrate`, **`.delete()` permanently deletes the
+> row** — the protection isn't active yet. Re-run it whenever you add or change a
+> model that uses these bases.
+
+### `makeguitarmigrations`
+
+`makemigrations` does **not** create the triggers and rules — they live in
+separate migrations generated by this command, and this step is **required** for
+soft deletion and the `updated_at` trigger to work. After your usual
+`makemigrations`, run:
+
+```bash
+python manage.py makeguitarmigrations
+```
+
+It scans your **first-party** apps for models with `_updated_at` / `_deleted_at`
+and writes the matching trigger/rule migrations. Tell it which apps are yours:
+
+```python
+# settings.py
+LOCAL_APPS = ["blog", "shop"]      # apps the command scans
+
+# Optional: which app hosts the shared trigger-function migration.
+# Defaults to LOCAL_APPS[0].
+# TRIGGER_FUNCTION_APP = "blog"
+```
+
+Use `--check` in CI to fail when advanced migrations are missing:
+
+```bash
+python manage.py makeguitarmigrations --check
+```
+
+### `DisableSignals`
+
+A context manager that temporarily disconnects Django signals — handy for bulk
+imports or silent saves:
+
+```python
+from django.db.models.signals import post_save
+
+from guitars.signals import DisableSignals
+
+with DisableSignals():                    # all default signals
+    instance.save()                       # nothing fires
+
+with DisableSignals(signals=[post_save]): # only the listed signals
+    instance.save()
+```
+
+## Development
+
+Requires [uv](https://docs.astral.sh/uv/) and Docker (for PostgreSQL).
+
+```bash
+uv sync                  # install dependencies + the package (editable)
+docker compose up -d     # start PostgreSQL (skip if you already run one on :5432)
+uv run pytest            # run the test suite
+uv run pytest --cov=guitars --cov-report=term-missing
+```
+
+The test suite defines concrete models in `tests/testapp` (the shipped package
+is abstract-only) and runs against a real PostgreSQL database so the rules and
+triggers are actually exercised.
+
+## License
+
+[MIT](LICENSE) © 2026 Behnam RK
+
+## Why "guitars"?
+
+Django Reinhardt was a legendary jazz guitarist. This package gives the *other*
+Django — the web framework — some better guitars: a grab-bag of utilities that
+make everyday Django a little nicer. The base models keep the theme going with
+`SetarModel` and `GuitarModel`.

django_guitars-0.1.0/core/asgi.py

@@ -0,0 +1,17 @@
+"""
+ASGI config for guitars project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'core.settings')
+
+application = get_asgi_application()