Metadata-Version: 2.5
Name: django-phase
Version: 0.2.0
Summary: Race-safe state machines for Django
Project-URL: Homepage, https://github.com/beyonder-deutschland/django-phase/
Project-URL: Documentation, https://django-phase.readthedocs.io/en/latest/index.html
Project-URL: Maintained by, https://beyonder.de/
Project-URL: Bugtracker, https://github.com/beyonder-deutschland/django-phase/issues
Project-URL: Changelog, https://django-phase.readthedocs.io/en/latest/features/changelog.html
Author-email: Beyonder Deutschland <hello@beyonder.de>
License: MIT License
        
        Copyright (c) 2026 Beyonder Deutschland GmbH
        
        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.
License-File: LICENSE.md
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Framework :: Django :: 6.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.15
Classifier: Topic :: Utilities
Requires-Python: >=3.11
Requires-Dist: django>=5.2
Provides-Extra: dev
Requires-Dist: ambient-package-update; extra == 'dev'
Requires-Dist: keyring~=25.7; extra == 'dev'
Requires-Dist: pre-commit~=4.7; extra == 'dev'
Requires-Dist: pytest-cov~=7.1; extra == 'dev'
Requires-Dist: pytest-django~=4.14; extra == 'dev'
Requires-Dist: pytest-mock~=3.17; extra == 'dev'
Requires-Dist: sphinx-mdinclude~=0.6; extra == 'dev'
Requires-Dist: sphinx-rtd-theme~=3.1; extra == 'dev'
Requires-Dist: sphinx~=8.2; extra == 'dev'
Requires-Dist: typer~=0.27; extra == 'dev'
Requires-Dist: uv~=0.13; extra == 'dev'
Description-Content-Type: text/markdown

[![PyPI release](https://img.shields.io/pypi/v/django-phase.svg)](https://pypi.org/project/django-phase/)
[![Downloads](https://static.pepy.tech/badge/django-phase)](https://pepy.tech/project/django-phase)
[![Coverage](https://img.shields.io/badge/Coverage-100.0%25-success)](https://github.com/beyonder-deutschland/django-phase/actions?workflow=CI)
[![Linting](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Coding Style](https://img.shields.io/badge/code%20style-Ruff-000000.svg)](https://github.com/astral-sh/ruff)
[![Documentation Status](https://readthedocs.org/projects/django-phase/badge/?version=latest)](https://django-phase.readthedocs.io/en/latest/?badge=latest)

Race-safe state machines for Django models: a protected `PhaseField`, transitions as one conditional `UPDATE`, and
guards that tell humans and machines why an action was refused.

[PyPI](https://pypi.org/project/django-phase/) • [GitHub](https://github.com/beyonder-deutschland/django-phase) • [Full documentation](https://django-phase.readthedocs.io/en/latest/index.html)

Creator & Maintainer: [Beyonder Deutschland](https://beyonder.de/)

## Features

* Declare the allowed transitions once, as a table on the field
* Assigning the phase directly raises; only `move()` changes it
* `move()` writes phase and further fields in **one** conditional `UPDATE`, so of two concurrent transitions from the
  same phase exactly one succeeds
* Every `save()` is guarded against a stale phase, so it can't silently undo a concurrent transition
* Phases as strings (`PhaseField`) or numbers (`IntegerPhaseField`); migrations see a plain Django field and never
  import `phase`
* System checks catch a missing mixin, a second phase field, a nullable one or one inherited from a concrete parent
  model
* `PhaseGuardError` gives refused actions a stable `code` for machines and a `detail` for humans
* Overrides no private Django method

```python
from django.db import models
from django.utils import timezone

from phase.fields import PhaseField
from phase.mixins.phase_guard import PhaseGuardMixin
from phase.transitions import move


class Order(PhaseGuardMixin, models.Model):
    class Status(models.TextChoices):
        OPEN = "open"
        PAID = "paid"
        SHIPPED = "shipped"
        CANCELLED = "cancelled"

    status = PhaseField(
        max_length=10,
        choices=Status.choices,
        default=Status.OPEN,
        transitions={
            Status.OPEN: (Status.PAID, Status.CANCELLED),
            Status.PAID: (Status.SHIPPED,),
        },
    )
    paid_at = models.DateTimeField(null=True, blank=True)


order = Order.objects.create()
move(obj=order, to=Order.Status.PAID, paid_at=timezone.now())

order.status = Order.Status.OPEN  # raises ProtectedPhaseFieldError
move(obj=order, to=Order.Status.OPEN)  # raises IllegalPhaseTransitionError
```

## Installation

- Install the package via pip:

  `pip install django_phase`

  or via uv:

  `uv add django_phase`

- Add module to `INSTALLED_APPS` within the main django `settings.py`:

```python
INSTALLED_APPS = (
    # ...
    "phase",
)
```

## Releasing a new version

Releases are fully automated. Push a version tag and the pipeline will build, sign with
[Sigstore](https://www.sigstore.dev/), publish to PyPI via
[Trusted Publishing](https://docs.pypi.org/trusted-publishers/), and create a GitHub Release —
no API tokens needed.

```bash
git tag v<version>          # e.g. git tag v1.2.3
git push origin v<version>
```

Tags **must** start with `v`. Tags without the prefix won't trigger the pipeline.

### First-time setup

Before the pipeline can run for the first time, an admin must:

1. **Create GitHub Environment `pypi`**
   - Go to *Settings → Environments → New environment*, name it exactly `pypi`
   - Under *Deployment branches and tags*, add a tag rule with pattern `v*`
   - Optionally add required reviewers for a manual approval gate

2. **Configure PyPI Trusted Publisher**
   - Go to *PyPI → Project settings → Publishing → Add a new publisher*
   - Fill in: Owner `beyonder-deutschland`, Repository `django-phase`,
     Workflow `release.yml`, Environment `pypi`

### Publish to ReadTheDocs.io

- Fetch the latest changes in GitHub mirror and push them
- Trigger new build at ReadTheDocs.io (follow instructions in admin panel at RTD) if the GitHub webhook is not yet set
  up.

### Maintenance

Please note that this package supports the [ambient-package-update](https://pypi.org/project/ambient-package-update/).
So you don't have to worry about the maintenance of this package. This updater is rendering all important
configuration and setup files. It works similar to well-known updaters like `pyupgrade` or `django-upgrade`.

To run an update, refer to the [documentation page](https://pypi.org/project/ambient-package-update/)
of the "ambient-package-update".
