Metadata-Version: 2.1
Name: django-mail-factory
Version: 0.24
Summary: Django Mail Manager
Home-page: https://github.com/peopledoc/django-mail-factory
Author: PeopleDoc
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: django
Requires-Dist: html2text
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: doc8 ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-django ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'

###################
Django Mail Factory
###################

.. image:: https://secure.travis-ci.org/peopledoc/django-mail-factory.png?branch=master
   :alt: Build Status
   :target: https://travis-ci.org/peopledoc/django-mail-factory
.. image:: https://img.shields.io/pypi/v/django-mail-factory.svg
   :target: https://crate.io/packages/django-mail-factory/
.. image:: https://img.shields.io/pypi/dm/django-mail-factory.svg
   :target: https://crate.io/packages/django-mail-factory/

Django Mail Factory lets you manage your email in a multilingual project.

* Authors: Rémy Hubscher and `contributors
  <https://github.com/peopledoc/django-mail-factory/graphs/contributors>`_
* Licence: BSD
* Compatibility: Django 1.11, 2.0, 2.1 and 2.2, python2.7, 3.5, 3.6 and 3.7
* Project URL: https://github.com/peopledoc/django-mail-factory
* Documentation: http://django-mail-factory.rtfd.org/


Hacking
=======

Setup your environment:

::

    git clone https://github.com/peopledoc/django-mail-factory.git
    cd django-mail-factory

Hack and run the tests using `Tox <https://pypi.python.org/pypi/tox>`_ to test
on all the supported python and Django versions:

::

    make test

If you want to give a look at the demo (also used for the tests):

::

    bin/python demo/manage.py syncdb  # create an administrator
    bin/python demo/manage.py runserver

You then need to login on http://localhost:8000/admin, and the email
administration (preview or render) is available at
http://localhost:8000/mail_factory/.


Release
=======

To prepare a new version:

* Create a branch named ``release/<version>``
* In a commit, change the ``CHANGELOG`` and ``VERSION`` file to remove the ``.dev0`` and set the date of the release
* In a second commit, change the ``VERSION`` to the next version number + ``.dev0``
* Create a PR for your branch
* When the PR is merged, tag the first commit with the version number, and create a github release using the ``CHANGELOG``

To release a new version (including the wheel)::

    pip install twine
    python setup.py sdist bdist_wheel
    twine upload --repository-url https://test.pypi.org/legacy/ dist/*

And after testing everything works fine on the testing repository::

    twine upload dist/*


