Metadata-Version: 2.0
Name: djangomailup
Version: 0.1.1
Summary: Django app to integrate with MailUp
Home-page: https://github.com/simobasso/djangomailup
Author: Simone Basso
Author-email: simone.basso@maieuticallabs.it
License: MIT
Keywords: djangomailup
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: rauth (>=0.7.2)

=============================
djangomailup
=============================

.. image:: https://badge.fury.io/py/djangomailup.png
    :target: https://badge.fury.io/py/djangomailup

.. image:: https://pyup.io/repos/github/simobasso/djangomailup/shield.svg
    :target: https://pyup.io/repos/github/simobasso/djangomailup/
    :alt: Updates

.. image:: https://travis-ci.org/simobasso/djangomailup.png?branch=master
    :target: https://travis-ci.org/simobasso/djangomailup

.. image:: https://codecov.io/gh/simobasso/djangomailup/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/simobasso/djangomailup

Django app to integrate with MailUp

Documentation
-------------

The full documentation is at https://djangomailup.readthedocs.org.

Requirements
------------

*  OAuth2 `tokens for the MailUp REST API`_
*  MailUp account
*  Django >= 1.8
*  python 2.7+, 3.4+

.. _tokens for the MailUp REST API: http://help.mailup.com/display/mailupapi/Authenticating+with+OAuth+v2

Quickstart
----------

Install djangomailup::

    pip install djangomailup


Add configuration in settings.py:

.. code-block:: python

    INSTALLED_APPS = [
        'djangomailup',
    ]

    MAILUP = {
        "default": {
            "client_id": "client_id",
            "client_secret": "client_secret",
            "username": "m1234",
            "password": "password",
        },
    }

Then use it in a project:

.. code-block:: python

    from djangomailup import MailUpClient

    client = MailUpClient()

Features
--------

* TODO

Running Tests
--------------

Does the code actually work?

.. code-block:: bash

    $ pip install -r requirements_test.txt
    $ python runtests.py

Credits
---------

Tools used this package:

*  Cookiecutter_
*  cookiecutter-djangopackage_
*  rauth_


.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _cookiecutter-djangopackage: https://github.com/pydanny/cookiecutter-djangopackage
.. _rauth: https://github.com/litl/rauth



History
-------

0.1.1 (2016-07-11)
++++++++++++++++++
* b5adb82 bumpversion: remove setup.py file from bumpersion config
* b1b3dc3 docs: add readme in index.rstw (#3)
* 666a6a1 docs: fix python works versions
* 62384fb docs: add Usage page
* 3264c1e docs: add installation page
* b963b72 readme: add requirements section
* 3b32da5 docs: add rtd_theme
* 55b2f63 requirements: add sphinx for building documentation

0.1.0 (2016-07-04)
++++++++++++++++++

* First release on PyPI.


