Metadata-Version: 1.1
Name: apiwrapper
Version: 0.1.8
Summary: Simple API Wrapper
Home-page: https://github.com/ardydedase/apiwrapper
Author: Ardy Dedase
Author-email: ardy.dedase@gmail.com
License: BSD
Description: =================================
        API Wrapper
        =================================
        
        .. image:: https://api.travis-ci.org/ardydedase/apiwrapper.svg
                :target: https://travis-ci.org/ardydedase/apiwrapper
        
        .. image:: https://img.shields.io/pypi/v/apiwrapper.svg
                :target: https://pypi.python.org/pypi/apiwrapper
        
        .. image:: https://readthedocs.org/projects/apiwrapper/badge/?version=latest
                :target: https://readthedocs.org/projects/apiwrapper/?badge=latest
                :alt: Documentation Status
        
        Simple API Wrapper
        
        * Free software: BSD license
        * Documentation: https://apiwrapper.readthedocs.org.
        
        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
        -------------------------------------
        
        .. code:: python
            
            # 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.
        
Keywords: apiwrapper
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
