entrouvert
/
python-emails
Archived
17
0
Fork 0
Code Issues Pull Requests Releases Activity

README update

This commit is contained in:
Sergey Lavrinenko 2015-02-27 12:43:07 +03:00
parent 4428ae1e3f
commit 8690dcb3f5
2 changed files with 37 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
AUTHORS.rst Normal file
View File

@ -0,0 +1,5 @@
Authors
```````
- Sergey Lavrinenko <s@lavr.me> `@lavr <https://github.com/lavr>`_

66
README.rst
View File

@ -3,22 +3,6 @@ python-emails
Modern email handling in python. Modern email handling in python.
Features
--------
- HTML-email message abstraction
- Method to transform html body:
- css inlining (using peterbe's premailer)
- image inlining
- DKIM signature
- Message loaders
- Send directly or via django email backend
Message abstraction:
--------------------
.. code-block:: python .. code-block:: python
m = emails.Message(html=T("<html><p>Build passed: {{ project_name }} <img src='cid:icon.png'> ..."), m = emails.Message(html=T("<html><p>Build passed: {{ project_name }} <img src='cid:icon.png'> ..."),
@ -41,8 +25,21 @@ but it is still more elegant, can be used in django environment and has html tra
(see ``HTML Transformer`` section). (see ``HTML Transformer`` section).
More examples: Features
-------------- --------
- HTML-email message abstraction
- Method to transform html body:
- css inlining (using peterbe's premailer)
- image inlining
- DKIM signature
- Message loaders
- Send directly or via django email backend
Examples
--------
Create message: Create message:
@ -176,28 +173,29 @@ Install on Ubuntu from PPA:
$ [sudo] apt-get install python-emails $ [sudo] apt-get install python-emails
TODO TODO
---- ----
- Documentation - Documentation
- 100% test coverage - Increase test coverage
- More accurate smtp session handling - Feature: load message from rfc2822
- ESP integration: Amazon SES, SendGrid, ... - Feature: export message to directory or zipfile
- deb package (ubuntu package almost done) - Performance: Patch pydkim for performance: i.e. preload key only once
- rpm package - Distribution: deb package (`debianization example <https://github.com/lavr/python-emails-debian/>`_)
- Patch pydkim for performance (i.e. preload key once, not each time) - Distribution: rpm package
- Flask extension - Other: Flask extension
- Feature: ESP integration - Amazon SES, SendGrid, ...
How to Help How to Help
----------- -----------
Library is under development and contributions are welcome! Library is under development and contributions are welcome.
1. Open an issue to start a discussion around a bug or a feature. 1. Open an issue to start a discussion around a bug or a feature.
2. Fork the repository on GitHub and start making your changes to a new branch. 2. Fork the repository on GitHub and start making your changes to a new branch.
3. Write a test which shows that the bug was fixed. 3. Write a test which shows that the bug was fixed.
4. Send a pull request. Make sure to add yourself to AUTHORS. 4. Send a pull request. Make sure to add yourself to `AUTHORS <https://github.com/lavr/python-emails/blob/master/README.rst>`_.
See also See also
@ -210,13 +208,13 @@ There are plenty other python email-around libraries:
- ... - ...
.. image:: https://travis-ci.org/lavr/python-emails.png?branch=master .. image:: https://travis-ci.org/lavr/python-emails.png?branch=master
:target: https://travis-ci.org/lavr/python-emails :target: https://travis-ci.org/lavr/python-emails
.. image:: https://coveralls.io/repos/lavr/python-emails/badge.svg?branch=master
:target: https://coveralls.io/r/lavr/python-emails?branch=master
.. image:: https://img.shields.io/pypi/v/emails.svg .. image:: https://img.shields.io/pypi/v/emails.svg
:target: https://pypi.python.org/pypi/emails :target: https://pypi.python.org/pypi/emails
.. image:: http://allmychanges.com/p/python/emails/badge/ .. image:: http://allmychanges.com/p/python/emails/badge/
:target: http://allmychanges.com/p/python/emails/?utm_source=badge :target: http://allmychanges.com/p/python/emails/?utm_source=badge
.. image:: https://coveralls.io/repos/lavr/python-emails/badge.svg?branch=master
:target: https://coveralls.io/r/lavr/python-emails?branch=master