django-pony-express

PyPI release Downloads Coverage Linting Coding Style Documentation Status

Welcome to the django-pony-express - class-based emails for Django shipping with a full test suite.

Similar to class-based view in Django core, this package provides a neat, DRY and testable (!) way to handle your emails in Django.

PyPI • GitHub • Full documentation

Creator & Maintainer: Ambient Digital

Features

  • Class-based structure for emails

    • Avoid duplicate low-level setup

    • Utilise inheritance and OOP benefits

    • No duplicated templates for HTML and plain-text

  • Test suite to write proper unit-tests for your emails

    • Access your test outbox like a Django queryset

Etymology

The Pony Express was an American express mail service that used relays of horse-mounted riders. […] During its 18 months of operation, the Pony Express reduced the time for messages to travel between the east and west US coast to about 10 days.

https://en.wikipedia.org/wiki/Pony_Express

The name of this package combines the Django mascot (a pony) with a once quite successful mail service in the US. Ingenious, right?

Installation

  • Install the package via pip:

    pip install django-pony-express

    or via uv:

    uv add django-pony-express

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

INSTALLED_APPS = (
    # ...
    "django_pony_express",
)

Releasing a new version

Releases are fully automated. Push a version tag and the pipeline will build, sign with Sigstore, publish to PyPI via Trusted Publishing, and create a GitHub Release — no API tokens needed.

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 ambient-innovation, Repository django-pony-express, 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. 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 of the “ambient-package-update”.

Contents:

Indices and tables