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
- 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
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.
The name of this package combines the Django mascot (a pony) with a once quite successful mail service in the US. Ingenious, right?
-
Install the package via pip:
pip install django_pony_express
or via pipenv:
pipenv install django_pony_express
-
Add module to
INSTALLED_APPS
within the main djangosettings.py
:INSTALLED_APPS = ( ... 'django_pony_express', )
- Create a Python virtualenv and activate it
- Install "pip-tools" with
pip install -U pip-tools
- Compile the requirements with
pip-compile --extra dev, -o requirements.txt pyproject.toml --resolver=backtracking
- Sync the dependencies with your virtualenv with
pip-sync
- Create a new branch for your feature
- Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
-e /Users/workspace/django-pony-express
or via pippip install -e /Users/workspace/django-pony-express
- Ensure the code passes the tests
- Create a pull request
-
Run tests
pytest --ds settings tests
-
Check coverage
coverage run -m pytest --ds settings tests coverage report -m
We use pre-push hooks to ensure that only linted code reaches our remote repository and pipelines aren't triggered in vain.
To enable the configured pre-push hooks, you need to install pre-commit and run once:
pre-commit install -t pre-push -t pre-commit --install-hooks
This will permanently install the git hooks for both, frontend and backend, in your local
.git/hooks
folder.
The hooks are configured in the .pre-commit-config.yaml
.
You can check whether hooks work as intended using the run command:
pre-commit run [hook-id] [options]
Example: run single hook
pre-commit run ruff --all-files --hook-stage push
Example: run all hooks of pre-push stage
pre-commit run --all-files --hook-stage push
- To build the documentation run:
sphinx-build docs/ docs/_build/html/
. - Open
docs/_build/html/index.html
to see the documentation.
If you have added custom text, make sure to wrap it in _()
where _
is
gettext_lazy (from django.utils.translation import gettext_lazy as _
).
How to create translation file:
- Navigate to
django-pony-express
python manage.py makemessages -l de
- Have a look at the new/changed files within
django_pony_express/locale
How to compile translation files:
- Navigate to
django-pony-express
python manage.py compilemessages
- Have a look at the new/changed files within
django_pony_express/locale
- 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.
-
Update documentation about new/changed functionality
-
Update the
Changelog
-
Increment version in main
__init__.py
-
Create pull request / merge to master
-
This project uses the flit package to publish to PyPI. Thus publishing should be as easy as running:
flit publish
To publish to TestPyPI use the following ensure that you have set up your .pypirc as shown here and use the following command:
flit publish --repository testpypi
Please note that this package supports the ambient-package-update.
So you don't have to worry about the maintenance of this package. All important configuration and setup files are
being rendered by this updater. 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".