Metadata-Version: 1.0
Name: chargehound
Version: 2.3.2
Summary: Chargehound Python Bindings
Home-page: https://www.chargehound.com
Author: Chargehound
Author-email: support@chargehound.com
License: MIT
Description: Chargehound python bindings
        ===========================
        
        |Build Status| |PyPI version|
        
        Installation
        ------------
        
        ``pip install chargehound``
        
        Usage
        -----
        
        Import chargehound and set your API key.
        
        .. code:: python
        
            import chargehound
            chargehound.api_key = '{ YOUR_API_KEY }'
        
        Requests
        ~~~~~~~~
        
        Every resource is accessed via the Chargehound module.
        
        .. code:: python
        
            dispute = chargehound.Disputes.submit('dp_123', fields={'customer_name': 'Susie'})
        
        Response
        ~~~~~~~~
        
        Responses from the API are automatically parsed from JSON and returned
        as Python objects.
        
        Responses also include the HTTP status code on the response object as
        the status field.
        
        .. code:: python
        
            dispute = chargehound.Disputes.retrieve('dp_123')
        
            print dispute.state
            # 'needs_response'
            print dispute.response.status
            # 200
        
        Documentation
        -------------
        
        `Disputes <https://www.chargehound.com/docs/api/index.html?python#disputes>`__
        
        `Errors <https://www.chargehound.com/docs/api/index.html?python#errors>`__
        
        Development
        -----------
        
        To build and install from the latest source:
        
        .. code:: bash
        
            $ git clone git@github.com:chargehound/chargehound-python.git
            $ pip install -r dev_requirements.txt
        
        Run tests:
        
        .. code:: bash
        
            $ python setup.py test
        
        Deployment
        ----------
        
        If you added a new depency, make sure the change is reflected in the
        ``requirements.txt`` file (for unit tests), the ``dev_requirements.txt``
        file (for module publishers) and the ``setup.py`` file (for module
        consumers).
        
        To deploy a new version of the SDK, you will need Pandoc
        (http://pandoc.org/) installed. Pandoc will convert the README.md into
        the .rst format required for the Python repository. Instructions are
        here: http://pandoc.org/installing.html.
        
        Next, install PyPandoc, the Python wrapper for Pandoc, following `these
        instructions <https://pypi.python.org/pypi/pypandoc>`__.
        
        The last pre-requisite is
        `Twine <https://pypi.python.org/pypi/twine>`__, a utility for
        interacting with PyPi.
        
        Once Pandoc, PyPandoc and Twine are installed, you can build and deploy
        a new module to PyPi with the following steps:
        
        1. Update the CHANGELOG to describe what feature have been added.
        2. Bump the version number in ``chargehound/version.py`` and
           ``setup.py``
        3. Rebuild and deploy the package with: ``python setup.py sdist``
        4. Upload the distributable to PyPi using:
           ``twine upload dist/{name_of_generated_package}``
        5. Confirm the new package version is available at
           https://pypi.python.org/pypi/chargehound
        
        .. |Build Status| image:: https://travis-ci.org/chargehound/chargehound-python.svg?branch=master
           :target: https://travis-ci.org/chargehound/chargehound-python
        .. |PyPI version| image:: https://badge.fury.io/py/chargehound.svg
           :target: https://badge.fury.io/py/chargehound
        
Platform: UNKNOWN
