thebestspinner 1.0.2
Python bindings for TheBestSpinner API
License: MIT
Keywords: API spinner TheBestSpinner

=========================================
Python bindings for The Best Spinner API.
=========================================

`The Best Spinner <http://thebestspinner.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
The Best Spinner API.

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


Install from package to virtualenv
==================================

.. sourcecode:: bash

    $ virtualenv --no-site-packages foo
    $ cd foo
    $ bin/pip install thebestspinner


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

.. sourcecode:: bash

    $ virtualenv --no-site-packages foo
    $ cd foo
    $ git clone git://github.com/niteoweb/thebestspinner.git
    $ bin/pip install thebestspinner/

    # running tests:
    $ bin/pip install unittest2 mock
    $ bin/test


Buildout
========

.. sourcecode:: bash

    $ git clone git://github.com/niteoweb/thebestspinner.git
    $ virtualenv --no-site-packages thebestspinner
    $ cd thebestspinner
    $ bin/python bootstrap.py
    $ bin/buildout

    # running tests:
    $ bin/test

    # check code for imperfections
    $ source bin/activate
    $ vvv src/tbs


Usage
=====

.. sourcecode:: python

    >>> original_text = "This is the text we want to spin"
    >>> import tbs
    >>> thebestspinner = tbs.Api('your_username', 'your_password')
    >>> spin_text = thebestspinner.identifySynonyms(original_text)
    >>> print spin_text
    u"{This is|This really is|That is|This can be} some text that we'd
     {like to|prefer to|want to|love to} spin"
    >>> thebestspinner.randomSpin(spin_text)
    u"This really is some text that we'd love to spin"

Changelog
=========

1.0.2 (2013-07-30)
------------------

- return full error message on exception
  [Matej Cotman]
- add some tests
  [Matej Cotman]
- fix: object has no attribute 'apiQuota'
  [Matej Cotman]
- add parts folder to git ignore
  [Matej Cotman]



1.0.1 (2012-12-05)
------------------

- documentation fix
  [Matej Cotman]


1.0 (2012-11-06)
----------------

- Code changed to use phpserialize from pypi instead of xml parser.
  [Matej Cotman]

Authors
=======

- Release 1.0
  Matej Cotman <cotman.matej@gmail.com>

- Releases to version 0.1.3
  Peter Flood <info@whywouldwe.com>

Copyright (c) 2010 Peter Flood

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.