Metadata-Version: 1.1
Name: sendypy
Version: 0.1.1b0
Summary: Python Interface for the Sendy API
Home-page: https://bitbucket.org/netlandish/sendypy/
Author: Netlandish Inc.
Author-email: hello@netlandish.com
License: UNKNOWN
Description: .. |nlshield| image:: https://img.shields.io/badge/100%-Netlandish-blue.svg?style=square-flat
                      :target: http://www.netlandish.com
        
        ==============================
        sendypy |nlshield|
        ==============================
        :Info: Simple module to interface with the Sendy API (https://sendy.co/api)
        :Version: 0.1
        :Author: Peter Sanchez (http://www.petersanchez.com) - (http://www.netlandish.com)
        
        Dependencies
        ============
        
        * It was written for Python 2.7+
        * Depends on the requests module
        
        Installation
        ============
        
        PIP::
        
            pip install sendypy
        
        Basic Manual Install::
        
            $ python setup.py build
            $ sudo python setup.py install
        
        Alternative Install (Manually):
        
        Place sendy directory in your Python path. Either in your Python installs site-packages directory or set your $PYTHONPATH environment variable to include a directory where the impersonate directory lives.
        
        
        Use
        ===
        All the variables and response values are described in the `Sendy API docs <https://sendy.co/api>`_
        
        Usage is simple ::
        
           from sendy import SendyAPI
           api = SendyAPI(host='https://your-sendy-install.com/sendy/', api_key='YOUR_API_KEY')
        
        You don't need to set the api_key variable if you're using the 
        subscribe or unsubscribe methods. You can also provide the optional
        "debug" variable (defaults to False). This will print debug into to 
        stdout when sending a request to your Sendy install.
        
        **Subscribe** ::
        
            api.subscribe('list_id_here', 'email@address.com', 'optional first name', custom_field_1='value', custom_field_2='value', ...)
        
        
        **Unsubscribe** ::
        
            api.unsubscribe('list_id_here', 'email@address.com')
        
        **Delete** ::
        
            api.delete('list_id_here', 'email@address.com')
        
        **Subscription Status** ::
        
            api.subscription_status('list_id_here', 'email@address.com')
        
        **Subscriber Count** ::
        
            api.subscriber_count('list_id_here')
        
        **Create Campaign** ::
        
            api.create_campaign(
                from_name='Your Name',
                from_email='Your Sender Email',
                reply_to='Your Reply-to Email',
                subject='Your Email Subject',
                plain_text='Plain Text Email Body',
                html_text='HTML Email Body',
                list_ids='list_id_1,list_id_2,list_id_3',
                brand_id='your brand id',
                query_string='Your query string',
                send_campaign=0, #default's to 0, use 1 to send email right away
            )
        
        
        Copyright & Warranty
        ====================
        All documentation, libraries, and sample code are
        Copyright 2016 Netlandish Inc., Peter Sanchez <petersanchez@gmail.com>. The library
        and sample code are made available to you under the terms of the BSD license
        which is contained in the included file, BSD-LICENSE.
        
        
        ==================
        Commercial Support
        ==================
        
        This software, and lots of other software like it, has been built in support of many of
        Netlandish's own projects, and the projects of our clients. We would love to help you
        on your next project so get in touch by dropping us a note at hello@netlandish.com.
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Environment :: Web Environment
