nfsnapi 0.3.0

Stuff to make working with the NearlyFreeSpeech.NET API easier.

A simple Python package with a couple of functions (and an exception class) that make working with the NearlyFreeSpeech.NET API easier.

nfsnapi supports Python 2.7 and later, and Python 3.2 and later. For general usage there are no prerequisites other than a supported version of Python, however to test nfsnapi with Python 3.2 and earlier versions the mock library is required.

Synopsis

>>> import nfsnapi
>>> # Replace USERNAME, API_KEY, and so on with actual values.
>>> nfsnapi.run_request("USERNAME", "API_KEY",
... "/account/ACCOUNT_NUMBER/balance")
u'10.56'
>>> nfsnapi.run_request("USERNAME", "API_KEY",
... "/dns/DOMAIN/listRRs", "type=A")
(A bunch of JSON not shown.)
>>> # And so on...

Installation

The usual python setup.py install dance will install nfsnapi if grabbing the source distribution. Alternatively, nfsnapi is available from PyPI via your Python package manager of choice.

Documentation and Testing

The nfsnapi module is heavily documented. Running nfnsapi-tests.py will, funnily enough, run some tests. The tests require a configuration file with API credentials and what-not (see nfnsapi-tests.py’s docstring for more information), and the mock library if testing with Python 3.2 or earlier.

There’s support for Tox, which will run the tests on all available and supported versions of Python.

Licence

nfsnapi was written by Damien Dart, <[e-mail]>. This is free and unencumbered software released into the public domain. For more information, please refer to the accompanying “UNLICENCE” file.