Metadata-Version: 1.1
Name: pyrate
Version: 0.3.3
Summary: Pyrate is a python wrapper for restful web apis. It's like magic but simpler.
Home-page: https://github.com/chive/pyrate
Author: Kim Thoenen
Author-email: kim@smuzey.ch
License: MIT
Description: pyrate
        ======
        
        Pyrate is a python wrapper for restful web apis. It's like *magic* but
        simpler.
        
        Currently, the following services are implemented
        
        -  Twitter (v1.1 + OAuth)
        -  Mailchimp (v2)
        -  Harvest
        -  Github
        
        Dependencies
        ------------
        
        -  `requests <http://python-requests.org>`__
        -  `requests\_oauthlib <https://github.com/requests/requests-oauthlib>`__
        
        Install
        -------
        
        ::
        
            # so simple
            pip install pyrate
        
        Usage
        -----
        
        Twitter
        ~~~~~~~
        
        ::
        
            from pyrate.services import twitter
        
            h = twitter.TwitterPyrate('oauth_consumer_key', 'oauth_consumer_secret',
                                      'oauth_token', 'oauth_token_secret')
        
            print(h.do('account/verify_credentials'))
            print(h.check_connection())
            print(h.tweet("This is awesome!"))
        
        Mailchimp
        ~~~~~~~~~
        
        ::
        
            from pyrate.services import mailchimp
        
            h = mailchimp.MailchimpPyrate('apikey')
        
            print(h.do('helper/ping'))
            print(h.check_connection())
            print(h.subscribeToList('ListName', 'myemail@example.com'))
            print(h.unsubscribeFromList('ListName', 'myemail@example.com'))
        
        Harvest
        ~~~~~~~
        
        ::
        
            from pyrate.services import harvest
        
            h = harvest.HarvestPyrate('user', 'password', 'organisation')
        
            print(h.do('account/who_am_i'))
            print(h.check_connection())
        
        Github
        ~~~~~~
        
        ::
        
            from pyrate.services import github
        
            h = github.GithubPyrate('user', 'password')
        
            print(h.do('#'))
            print(h.check_connection())
            h.create_repo('name', 'description', private=True)
            h.create_repo('name', 'description', 'organisation')
            h.delete_repo('name')
        
        Todos
        -----
        
        -  Create more "convenience"-methods (like
           ``h.tweet("This is awesome!")``)
        -  Implement CLI-Interface (see branch
           `cli-interface <https://github.com/Chive/pyrate/tree/cli-interface>`__
        -  Add more services (Open for suggestions!)
        -  Create Documentation
        -  lots and lots more
        
        
Platform: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Communications
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
