Skip to main content

Simple API Wrapper

Project description

https://api.travis-ci.org/ardydedase/apiwrapper.svg https://img.shields.io/pypi/v/apiwrapper.svg Documentation Status

Simple API Wrapper

Overview

Recently noticed a pattern and repeated pieces of code in Python API wrappers for simple requests and polling. A separate Python package will minimize code duplication and encourage de-coupling of logic from the API request functions.

Installation

At the command line:

$ easy_install apiwrapper

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv apiwrapper
$ pip install apiwrapper

Getting started with a simple request

# as a helper class
from apiwrapper import APIWrapper

my_api = APIWrapper()
url = 'https://api.github.com/users/ardydedase/repos'
resp = my_api.make_request(url=url)
print(resp)

# as a parent class
class GithubAPI(APIWrapper):
    def get_repos(self, username):
        """
        Uses `make_request` method
        """
        url = "https://api.github.com/users/{username}/repos".format(username=username)
        return self.make_request(url, method='get', headers=None, data=None, callback=None)

More features including polling

Read the docs: https://apiwrapper.readthedocs.org/en/latest/usage.html

Or use apiwrapper/apiwrapper.py as a reference. Implementation is straightforward.

History

0.1.0 (2015-01-11)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiwrapper-0.1.8.tar.gz (18.0 kB view hashes)

Uploaded Source

Built Distribution

apiwrapper-0.1.8-py2.py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page