codebykyle / mailerlite_extensions

This package extends the Mailerlite Python library to include useful features

mailerlite_extensions

Mailerlite Extensions

This package extends the Mailerlite Python library to include useful features like a cached group model which limits round trips to Mailerlite, and additional subscriber functions left out of the official package like updating a users e-mail address.

Installing

pip install git+https://github.com/codebykyle/mailerlite_extensions

or via ssh:

pip install git+ssh://[e-mail]/codebykyle/mailerlite_extensions.git

Usage

from mailerlite_extensions.overrides import MailerliteExtensionsClient

api = MailerliteExtensionsClient({
    'api_key': MAILERLITE_API_KEY
})

# Build the group cache
api.populate_cache()

Get or create a group

api.groups.get_or_create_group("testing")

Update a users email address:

api.subscribers.update_email('[e-mail]', '[e-mail]')

Requirements

Package requirements are handled using pip. To install them do

pip install -r requirements.txt

Tests

Testing is set up using pytest and coverage is handled with the pytest-cov plugin.

Run your tests with py.test in the root directory.

Coverage is ran by default and is set in the pytest.ini file. To see an html output of coverage open htmlcov/index.html after running the tests.

Todo

• Add unit tests