Metadata-Version: 1.1
Name: mailupy
Version: 1.1.0
Summary: Yet another Mailup Python client
Home-page: https://github.com/lotrekagency/mailupy
Author: Lotrèk
Author-email: dimmitutto@lotrek.it
License: MIT
Description: mailupy
        =======
        
        💌 Yet another `MailUp <https://www.mailup.it/>`__ Python client
        
        |Latest Version| |codecov| |Build Status| |License: MIT|
        
        Contributing
        ------------
        
        Any help is welcome, as long as you don't break the continuous
        integration. Fork the repository and open a Pull Request directly on the
        master branch. A maintainer will review and integrate your changes.
        
        Maintainers:
        
        -  `Andrea Stagi <https://github.com/astagi>`__
        -  `Edoardo Grassi <https://github.com/edoaxyz>`__
        
        Contributors:
        
        -  `Fabio Piras <https://github.com/Arussil>`__
        
        Install
        -------
        
        .. code:: sh
        
            pip install mailupy
        
        How to use
        ----------
        
        Import Mailupy and instantiate the client
        
        .. code:: py
        
            from mailupy import Mailupy
        
            client = Mailupy(
                'm00000',
                'm@1lUPf4k3',
                '8123dbff-d12c-4e3d-a55e-23a8c5a303f8',
                '16cadddf-a145-45db-9347-a5ab51ac223d'
            )
        
        Examples
        --------
        
        Getting information about fields, groups...
        
        .. code:: py
        
            for field in client.get_fields():
                print (field)
        
        .. code:: py
        
            for group in client.get_groups_from_list(1):
                print (group)
        
        Getting recipients from lists using `Ordering and Filtering (Mailup
        Documentation) <http://help.mailup.com/display/mailupapi/Paging+and+filtering>`__
        
        .. code:: py
        
            for group in client.get_groups_from_list(
                    1, filter_by='Name.Contains(\'Farm\')',
                    order_by=['Name asc', 'idGroup desc']):
                print (group)
        
        .. code:: py
        
            for recipient in client.get_subscribed_recipients_from_list(
                    1, filter_by='Email.Contains(\'zzz\')',
                    order_by=['Email desc']):
                print (recipient['Email'])
        
        Getting a subscribed recipient from a list
        
        .. code:: py
        
            client.get_subscribed_recipient_from_list(1, 'andrea.stagi@lotrek.it')
        
        Subscribe/Unsubscribe recipient to/from lists
        
        .. code:: py
        
            recipient_id = client.subscribe_to_list(
              1, 'Andrea Stagi', 'stagi.andrea@gmail.com', pending=False
            )
        
            client.unsubscribe_from_list(1, recipient_id)
        
        Run tests
        ---------
        
        .. code:: sh
        
            pip install -r requirements-dev.txt
            make test
        
        .. |Latest Version| image:: https://img.shields.io/pypi/v/mailupy.svg
           :target: https://pypi.python.org/pypi/mailupy/
        .. |codecov| image:: https://codecov.io/gh/lotrekagency/mailupy/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/lotrekagency/mailupy
        .. |Build Status| image:: https://travis-ci.org/lotrekagency/mailupy.svg?branch=master
           :target: https://travis-ci.org/lotrekagency/mailupy
        .. |License: MIT| image:: https://img.shields.io/badge/License-MIT-blue.svg
           :target: https://github.com/lotrekagency/mailupy/blob/master/LICENSE
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
