Metadata-Version: 1.1
Name: crowdflower
Version: 0.0.2
Summary: Crowdflower API - Python Client
Home-page: https://github.com/chbrown/crowdflower
Author: Christopher Brown
Author-email: io@henrian.com
License: Copyright (c) 2014 Christopher Brown

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.

Description: crowdflower
        ===========
        
        Minimal client library for interacting with the
        `CrowdFlower <http://www.crowdflower.com/>`__ API with Python.
        
        Installation
        ------------
        
        Install from github at this point:
        
        ::
        
            git clone https://github.com/chbrown/crowdflower.git
            cd crowdflower
            python setup.py develop
        
        Example use
        -----------
        
        Import:
        
        ::
        
            import crowdflower
        
        CrowdFlower API keys are 20 characters long; the one below is just
        random characters.
        
        ::
        
            conn = crowdflower.Connection('LbcxvIlE3x1M8F6TT5hN')
        
        This library will default to an environment variable called
        ``CROWDFLOWER_API_KEY`` if none is specified here:
        
        ::
        
            conn = crowdflower.Connection()
        
        Loop through all your jobs and print the titles:
        
        ::
        
            for job in conn.jobs():
                print job['title']
        
        Create a new job with some new units:
        
        ::
        
            job = conn.upload(data)
            print job
        
        Fancy stuff
        -----------
        
        Run a bunch of DELETE calls on each item in the job.
        
        ::
        
            for delete_response in job.clear_units():
                print delete_response
        
        If you don't want to print the responses, you still need to exhaust the
        loop:
        
        ::
        
            list(job.clear_units())
        
        License
        -------
        
        Copyright © 2014 Christopher Brown. `MIT
        Licensed <https://raw.github.com/chbrown/crowdflower/master/LICENSE>`__.
        
Keywords: crowdflower crowdsourcing api client
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
