A python client for the Cheddar Getter API (https://cheddargetter.com)
Python
Clone or download
Pull request Compare This branch is 52 commits ahead of SeanOC:master.
galitskyd Merge pull request #8 from smartfile/fix-keyerror
Check that cc info is in the request before removing it
Latest commit b7ded77 Jun 20, 2016
Permalink
Failed to load latest commit information.
docs
sharpy
tests got tests to run on sharpy. Added new test to parse promotions. See #… Mar 17, 2016
.gitignore Added the --failed flag to the nose config. Jan 11, 2011
LICENSE.txt More project infrastructure bits. Jan 6, 2011
MANIFEST.in A few README and docs tweaks. Jan 25, 2011
README.rst Formatting updates for code in readme Aug 21, 2015
dev-requirements.txt
setup.cfg
setup.py I hate to be that guy but OCD. PEP8 fixes. Aug 27, 2015

README.rst

Sharpy

Sharpy is a client for the Cheddar Getter (https://cheddargetter.com/) API. Cheddar Getter is a great service for handling recurring and usage based billing.

There are some existing python Cheddar Getter clients but they have significant licensing problems, packaging problems, bugs, and are only partial implementations of the Cheddar Getter API.

Sharpy offers a number of advantages:

  • Clear and simple BSD license.
  • Both a high and low level API - Work with cheddar the way you want to.
  • 100% test coverage.
  • Proper packaging - Sharpy can be installed via easy_install and PIP.
  • Implements almost all of the Cheddar Getter API (See TODOs below).
  • Will have complete documentation soon.

That all being said, sharpy is still very new and is likely to undergo some significant API changes in the near future. The code should be fairly safe to use as long as you understand that future releases may not be backwards compatible.

Getting Started

To get started with Sharpy, simply install it like you would any other python package

pip install sharpy

Optionally, you can also install lxml on your system for faster XML parsing.

Once you have sharpy installed, checkout our docs on how to use the library.

Documentation

Sharpy's documentation is available at ReadTheDocs or in the docs directory of the project.

Code

You can checkout and download Sharpy's latest code at Github.

Installing elementtree for Development and Unit Testing

When trying to install elementtree, pip may report that there is no such package. If this happens to you, you can work around by downloading and installing it manually.

wget http://effbot.org/media/downloads/elementtree-1.2.6-20050316.zip
unzip elementtree-1.2.6-20050316.zip
cd elementtree-1.2.6-20050316/
pip install .

TODOs

  • Flesh out the documentation to cover the full API.
  • Add support for the various filtering options in the get_customers call.