Metadata-Version: 2.1
Name: ims-api-connector
Version: 2018.1
Summary: A connector for the FTP Technologies IMS API
Home-page: https://github.com/initialed85/ims-python-api-connector
Author: Edward Beech
Author-email: edward.beech@ftpsolutions.com.au
License: MIT
Description: # ims-python-api-connector
        
        Connector for the FTP Technologies IMS HTTP API
        
        ## How to install
        
        `$ pip install ims-api-connector`
        
        ## How to use
        
        There are `.connect()` and `.close()` methods exposed as well as a context manager API (`__enter__()` and `__exit__()`) but you don't have to use either- simply calling `.get()`, `.post()` etc will handle the authentication for you.
        
        Additionally, it will retry authentication if it picks up an authentication error during a request (to handle expired tokens etc) but if the attempt to re-authenticate fails, it will stop retrying.
        
        ```
        from ims_api_connector import IMSAPIConnector
        
        connector = IMSAPIConnector(
            url='https://some.ims.instance.com/api/',
            username='some_username',
            password='some_password',
            timeout=5,  # optional; seconds until a request times out
            retries=6,  # optional; number of re-auth attempts during a request
            backoff=5,  # optional; seconds between re-auth attempts
            insecure=False,  # optional; ignore certificate warnings
            logger=None,  # optional; Python logger object
        )
        
        connector.get('assets/?limit=50000')
        ```
        
        Which returns an object like this:
        
        ```
        Response(
            status_code=200,
            text='{"some": "data"}',
            json={'some': 'data'},
            error=None,  # any JSON parse exception object
            traceback=None,  # traceback string for JSON parse exception
        )
        ```
        
        ## How to develop
        
        Prerequisites:
        
        * pip
        * virtualenvwrapper
        * entr
        
        Instructions:
        
        * Create a virtualenv
            * `mkvirtualenv ims-python-api-connector`
        * Install the requirements
            * `pip install -r requirements.txt`
Keywords: sample setuptools development
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: test
Provides-Extra: dev
