DESCRIPTION.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. =====================
  2. django-templated-mail
  3. =====================
  4. .. image:: https://img.shields.io/pypi/v/django-templated-mail.svg
  5. :target: https://pypi.org/project/django-templated-mail
  6. .. image:: https://img.shields.io/travis/sunscrapers/django-templated-mail.svg
  7. :target: https://travis-ci.org/sunscrapers/django-templated-mail
  8. .. image:: https://img.shields.io/codecov/c/github/sunscrapers/django-templated-mail.svg
  9. :target: https://codecov.io/gh/sunscrapers/django-templated-mail
  10. .. image:: https://img.shields.io/scrutinizer/g/sunscrapers/django-templated-mail.svg
  11. :target: https://scrutinizer-ci.com/g/sunscrapers/django-templated-mail
  12. A simple wrapper for ``django.core.mail.EmailMultiAlternatives`` which makes
  13. use of Django template system to store email content in separate file.
  14. Developed by `SUNSCRAPERS <http://sunscrapers.com/>`_ with passion & patience.
  15. Installation
  16. ============
  17. Simply install using ``pip``:
  18. .. code-block:: bash
  19. $ pip install -U django-templated-mail
  20. Documentation
  21. =============
  22. Documentation is available to study at
  23. `http://django-templated-mail.readthedocs.io <http://django-templated-mail.readthedocs.io>`_
  24. and in ``docs`` directory.
  25. Contributing and development
  26. ============================
  27. To start developing on **django-templated-mail**, clone the repository:
  28. .. code-block:: bash
  29. $ git clone git@github.com:sunscrapers/django-templated-mail.git
  30. If you are a **pipenv** user you can quickly setup testing environment by
  31. using Make commands:
  32. .. code-block:: bash
  33. $ make init
  34. $ make test