Client library for interacting with the CrowdFlower API with Python.
Install from PyPI:
easy_install -U crowdflower
Or install the latest version GitHub:
git clone https://github.com/chbrown/crowdflower.git
cd crowdflower
python setup.py develop
Import:
import crowdflower
CrowdFlower API keys are 20 characters long; the one below is just random characters. You can get your API key from: https://make.crowdflower.com/account/user
conn = crowdflower.Connection(api_key='LbcxvIlE3x1M8F6TT5hN')
The library will default to an environment variable called CROWDFLOWER_API_KEY if
none is specified here:
conn = crowdflower.Connection()
If you want to cache job responses, like judgments, properties, and tags, you
can initialize the connection with a cache. cache='filesystem' is the only
option currently supported, and serializes JSON files to /tmp/crowdflower/*.
conn = crowdflower.Connection(cache='filesystem')
Loop through all your jobs and print the titles:
for job in conn.jobs():
print job.properties['title']
Create a new job with some new units:
data = [
{'id': '1', 'name': 'Chris Narenz', 'gender_gold': 'male'},
{'id': '2', 'name': 'George Henckels'},
{'id': '3', 'name': 'Maisy Ester'},
]
job = conn.upload(data)
res = job.update({
'title': 'Gender labels',
'included_countries': ['US', 'GB'], # Limit to the USA and United Kingdom
# Please note, if you are located in another country and you would like
# to experiment with the sandbox (internal workers) then you also need to add
# your own country. Otherwise your submissions as internal worker will be rejected
# with Error 301 (low quality).
'payment_cents': 5,
'judgments_per_unit': 2,
'instructions': 'some instructions html',
'cml': 'some layout cml: <cml:text label="Sample text field:" validates="required" />',
'options': {
'front_load': 1, # quiz mode = 1; turn off with 0
}
})
if 'errors' in res:
print(res['errors'])
exit()
job.gold_add('gender', 'gender_gold')
print job
# delete all the jobs that were created by the above sample code:
for job in conn.jobs():
if job.properties['title'] == 'Gender labels':
print("Deleting " + str(job.id))
res = job.delete()
print res
# {u'message': {u'success': u'Job 552771 has been deleted.'}}
# To launch a job for internal workers (sandbox):
res = job.launch(mode='cf_internal', units_count=2)
# To launch a job for on-demand workers:
res = job.launch(mode='on_demand', units_count=2)
# To get the status of a job:
print job.ping()
# To download the results of a job write this:
for row in job.download():
print row
In order to turn on logging use the following in your script:
import logging
logging.basicConfig(level=logging.DEBUG)
The official Ruby client is hard to use, which is surprising, since the CrowdFlower API is so simple.
Which is not to say the CrowdFlower API is all ponies and rainbows, but all the documentation is there on one page, and it does what it says, for the most part. (Though there's more that you can do, beyond what's documented.)
Thus, a thin Python client for the CrowdFlower API.
This package uses kennethreitz's Requests to communicate with the CrowdFlower API over HTTP. Requests is Apache2 licensed.
Copyright 2014 People Pattern Corporation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.