Chargehound Python Bindings
Project description
Installation
pip install chargehound
Usage
Import chargehound and set your API key.
import chargehound
chargehound.api_key = '{ YOUR_API_KEY }'
Documentation
Development
To build and install from the latest source:
$ git clone git@github.com:chargehound/chargehound-python.git
$ pip install -r dev_requirements.txt
Run tests:
$ python setup.py test
Deployment
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.
The last pre-requisite is 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:
Update the CHANGELOG to describe what feature have been added.
Bump the version number in chargehound/version.py
Rebuild and deploy the package with: python setup.py sdist
Upload the distributable to PyPi using: twine upload dist/{name_of_generated_package}
Confirm the new package version is available at https://pypi.python.org/pypi/chargehound
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.