Newsletter generator for MailChimp
Project description
NewsChimp
=========
Generator of monthly newsletter campaigns on MailChimp. Based od laziness and boredom.
Status
------
In heavy development. Please touch anything important for fun.
Usage
-----
.. code-block:: bash
$ chimpgen --help
Usage: chimpgen [OPTIONS] COMMAND [ARGS]...
Options:
--config PATH Custom config file
--help Show this message and exit.
Commands:
fb Facebook curator
gg Google Groups curator
lanyrd Meetup listing
renderer HTML and text email rendering
sender Campaign creation
If you want to use subcommand with config, do it in format
.. code-block:: bash
$ chimpgen --config PATH command
Config
------
Default config file is ``./config.yaml``. Here's minimalistic setting:
.. code-block:: yaml
month:
facebook:
group_id:
google:
group_name:
# Events for lanyrd to search
events:
-
# Input template
template:
context:
# Additional template context
header:
# Template outputs
output:
text:
html:
# MailChimp settings
mailchimp:
list:
subject:
reciever:
sender:
email:
name:
You also need to setup environment variables (for automatic campaign creation):
- ``FACEBOOK_TOKEN``
- ``MAILCHIMP_KEY``
Requirements
------------
Python 3 and stuff in ``requirements.txt``
License
-------
See LICENSE file
TODO
----
- Newsletter creation wizard
- Support of more social sources
- Better config structure
=========
Generator of monthly newsletter campaigns on MailChimp. Based od laziness and boredom.
Status
------
In heavy development. Please touch anything important for fun.
Usage
-----
.. code-block:: bash
$ chimpgen --help
Usage: chimpgen [OPTIONS] COMMAND [ARGS]...
Options:
--config PATH Custom config file
--help Show this message and exit.
Commands:
fb Facebook curator
gg Google Groups curator
lanyrd Meetup listing
renderer HTML and text email rendering
sender Campaign creation
If you want to use subcommand with config, do it in format
.. code-block:: bash
$ chimpgen --config PATH command
Config
------
Default config file is ``./config.yaml``. Here's minimalistic setting:
.. code-block:: yaml
month:
facebook:
group_id:
google:
group_name:
# Events for lanyrd to search
events:
-
# Input template
template:
context:
# Additional template context
header:
# Template outputs
output:
text:
html:
# MailChimp settings
mailchimp:
list:
subject:
reciever:
sender:
email:
name:
You also need to setup environment variables (for automatic campaign creation):
- ``FACEBOOK_TOKEN``
- ``MAILCHIMP_KEY``
Requirements
------------
Python 3 and stuff in ``requirements.txt``
License
-------
See LICENSE file
TODO
----
- Newsletter creation wizard
- Support of more social sources
- Better config structure
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
NewsChimp-0.1.4.tar.gz
(7.2 kB
view hashes)