README.md 1.16 KB
Newer Older
1
2
[![build status](http://gitlab.adrima.es/AdrianRibao/cartero/badges/master/build.svg)](http://gitlab.adrima.es/AdrianRibao/cartero/commits/master)

3
# Cartero - Newsletter django app
Adrián Ribao's avatar
Adrián Ribao committed
4

5
Cartero is a newsletter app for Django with the following features:
Adrián Ribao's avatar
Adrián Ribao committed
6

7
8
9
10
11
12
13
14
* Inline template editing
* Dinamic content in templates defining placeholders
* Track unsucriptions
* Short URLs in template and monitor clicks
* Track email views via a transparent image
* Automatically convert HTML emails to text versions
* Dinamic variables in templates
* It's possible to send test emails
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
* Rate Limit emails per second

# Installation

Installation is easy. It requires celery configured in order to send emails as an asynchronous task.

1. Add `cartero` to **INSTALLED_APPS**

2. Add cartero urls:

   ```python
       url(r'^cartero/', include('cartero.urls')),
   ```

3. Add the celery task

   ```python
       CELERYBEAT_SCHEDULE = {
           'runs-every-minute': {
               'task': 'cartero.tasks.check_campaigns',
               'schedule': timedelta(seconds=60),
           },
       }
   ```
39

Adrián Ribao's avatar
Adrián Ribao committed
40
# TODO:
41
42

* Create lists of users
Adrián Ribao's avatar
Adrián Ribao committed
43
44
45

# Authors

46
* Adrián Ribao. [Twitter](http://twitter.com/AdrianRibao).