Skip to content

Chive/pyrate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyrate

Number of PyPI downloads Build Status Code Coverage

Bitdeli Badge

Pyrate is a python wrapper for restful web apis. It's like magic but simpler.

Currently, the following services are implemented

There's a quick-start guide below, for full documentation (WIP) visit: http://pyrate.readthedocs.org/en/latest/

Dependencies

Installation

pip install pyrate

Quick Start

Twitter

from pyrate.services import twitter

h = twitter.TwitterPyrate(
    oauth_consumer_key='',
    oauth_consumer_secret='',
    oauth_token='',
    oauth_token_secret=''
)

# check if the connection works
h.check_connection()

# direct api call
h.get('account/verify_credentials')

# convenient tweeting!
h.tweet("This is awesome!")

Mailchimp

from pyrate.services import mailchimp

h = mailchimp.MailchimpPyrate(apikey='')

# check if the connection works
h.check_connection()

# direct api call
h.do('helper/ping')

# (un)subscribing to lists!
h.subscribeToList('ListName', '[email protected]')
h.unsubscribeFromList('ListName', '[email protected]')

Harvest

from pyrate.services import harvest

h = harvest.HarvestPyrate(
    user='',
    password='',
    organisation=''
)

# check if the connection works
h.check_connection()

# tell me who I am
h.do('account/who_am_i')

Github

from pyrate.services import github

h = github.GithubPyrate(
    user='',
    password=''
)

# check if the connection works
h.check_connection()

# create & delete repositories!
h.create_repo('name', 'description', private=True)
h.create_repo('name', 'description', 'organisation')
h.delete_repo('name')

Basecamp

from pyrate.services import basecamp

h = basecamp.BasecampPyrate(
    user='',
    password='',
    org_id=''
)

# check if the connection works
h.check_connection()

# what projects are there?
print(h.do('projects'))

Todos

  • Create more "convenience"-methods (like h.tweet())
  • Implement CLI-Interface (see branch feature/cli)
  • Add more services (Open for suggestions!)
  • Expand Documentation
  • lots and lots more

About

a python wrapper for restful apis

Resources

License

Stars

Watchers

Forks

Packages

No packages published