spinnerchief 0.1.1
Python bindings for SpinnerChief API
License: BSD
Keywords: API spinner SpinnerChief

=====================================
Python bindings for SpinnerChief API.
=====================================

`Spinner Chief <http://www.spinnerchief.com/>`_ is an online
service for spinning text (synonym substitution) that creates unique version(s)
of existing text. This package provides a way to easily interact with
`SpinnerChief API <http://developer.spinnerchief.com/API_Document.aspx>`_.
Usage requires an account, `get one here <http://account.spinnerchief.com/>`_
and an api key which you get by registering
a `developer account <http://developer.spinnerchief.com/>`_.

* `Source code @ GitHub <https://github.com/niteoweb/spinnerchief>`_


Install within virtualenv
=========================

.. sourcecode:: bash

    $ virtualenv foo
    $ cd foo
    $ git clone https://github.com/niteoweb/spinnerchief
    $ bin/pip install spinnerchief/

    # running tests:
    $ bin/pip install unittest2 mock
    $ bin/python -m unittest discover -s spinnerchief/src/spinnerchief/tests


Buildout
========

.. sourcecode:: bash

    $ git clone https://github.com/niteoweb/spinnerchief
    $ cd spinnerchief
    $ python bootstrap.py
    $ bin/buildout

    # running tests:
    $ bin/py -m unittest discover -s src/spinnerchief/tests

    # check code for imperfections
    $ bin/vvv src/spinnerchief


Usage
=====

.. sourcecode:: python

    >>> import spinnerchief
    >>> sc = spinnerchief.SpinnerChief("<yourapikey>", "<yourusername>", "<yourpassword>")

    >>> sc.text_with_spintax(text="My name is Ovca!")
    "{I am|I'm|My friends call me|Throughout southern california|Im} Ovca!"

    >>> sc.unique_variation(text="My name is Ovca!")
    "Im Ovca!"

    >>> print "used: %s" % sc.quota_used()
    used: 2

    >>> print "left: %s" % sc.quota_left()
    left: 18

Changelog
=========

0.1 (2012-09-18)
----------------

- SpinnerChief class.
- Tests and documentation.
  [Matej Cotman]

License (3-clause BSD)
======================

Copyright (c) 2012, NiteoWeb Ltd.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

* Neither the name of NiteoWeb Ltd. nor the names of its contributors may
  be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL NITEOWEB LTD. BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.