Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A python client for the Cheddar Getter API (https://cheddargetter.com)
Python
Branch: master

Merge pull request #13 from banzo/patch-1

Update sharpy/product.py
latest commit 935943ca86
@SeanOC authored
Failed to load latest commit information.
docs Add a bit to the get customer to show handling not-found and testing …
sharpy Update sharpy/product.py
tests Updated the clear_users call to match an CG API update.
.gitignore Added the --failed flag to the nose config.
LICENSE.txt
MANIFEST.in A few README and docs tweaks.
README.rst Another typo fix.
dev-requirements.txt Added the normal package dependencies to the dev-requirements.txt file.
setup.cfg Made endpoint a configurable parameter, so we can test against the te…
setup.py Allow use of distribute/setuptools for "develop" mode

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.

TODOs

  • Flesh out the documentation to cover the full API.
  • Add support for the various filtering options in the get_customers call.
Something went wrong with that request. Please try again.