<commit_before>.. pybossa-client documentation master file, created by
   sphinx-quickstart on Tue Oct 16 11:21:34 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pybossa-client's documentation!
==========================================

This small library will help you to create and manage your applications in
a `PyBossa server <http://pybossa.com>`_.

Install
-------

You can install pybossa-client using **pip**, preferably while working in a 
`virtualenv <http://www.virtualenv.org/en/latest/index.html>`_::

    $ pip install https://github.com/PyBossa/pybossa-client/zipball/master 

Usage
-----

Setup::

    import pbclient

    # setup the server connection
    pbclient.set('endpoint', 'http://pybossa.com')
    pbclient.set('api_key', '--your-api-key-here--')

Create an application::

    pbclient.create_app('Name of the App', 'shortname', 'Description')

Change the long description of an app::

    app = pbclient.find_app(short_name='flickrperson')
    app.long_description = open('longdesc.html').read()
    
    pbclient.update_app(app)

Create a new task::

    task_info = {
        'image': 'http://farm9.staticflickr.com/8146/7566819662_f2c74e77d8_m.jpg'
    }
    pbclient.create_task(app_id, task_info)

Module overview
---------------

.. automodule:: pbclient
    :members:
   pybossa-client


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
<commit_msg>Fix automodule error.<commit_after>.. pybossa-client documentation master file, created by
   sphinx-quickstart on Tue Oct 16 11:21:34 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pybossa-client's documentation!
==========================================

This small library will help you to create and manage your applications in
a `PyBossa server <http://pybossa.com>`_.

Install
-------

You can install pybossa-client using **pip**, preferably while working in a 
`virtualenv <http://www.virtualenv.org/en/latest/index.html>`_::

    $ pip install https://github.com/PyBossa/pybossa-client/zipball/master 

Usage
-----

Setup::

    import pbclient

    # setup the server connection
    pbclient.set('endpoint', 'http://pybossa.com')
    pbclient.set('api_key', '--your-api-key-here--')

Create an application::

    pbclient.create_app('Name of the App', 'shortname', 'Description')

Change the long description of an app::

    app = pbclient.find_app(short_name='flickrperson')
    app.long_description = open('longdesc.html').read()
    
    pbclient.update_app(app)

Create a new task::

    task_info = {
        'image': 'http://farm9.staticflickr.com/8146/7566819662_f2c74e77d8_m.jpg'
    }
    pbclient.create_task(app_id, task_info)

Module overview
---------------

.. automodule:: pbclient
    :members:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

{'fraction_non_alphanumeric': 0.16821192052980133, 'fraction_numerical': 0.02185430463576159, 'mean_word_length': 3.669242658423493, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2042479', 'n_tokens_mistral': 1035, 'n_tokens_neox': 943, 'n_words': 251}