Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Library for creating Mechanical Turk workflows in python scripts.

Project Description
turkflow
========

Library for quickly creating Mechanical Turk workflows. In some ways, turkflow ended up being an accidental re-implementation of [TurKit](http://dl.acm.org/citation.cfm?id=1866029.1866040&coll=DL&dl=GUIDE&CFID=308021477&CFTOKEN=94691217).

``turkflow`` allows you to specify arbitrary HTML HITs in [jinja2](http://jinja.pocoo.org/docs/) template files and python objects. It also provides functionality for waiting on the results of those HITs, checking HITs previously created by ``turkflow`` for completion, and parsing the results into a python structure.

## Installation
The recommended way to install ``turkflow`` is with ``pip``:

pip install turkflow

You also need to create a [boto configuration file](https://code.google.com/p/boto/wiki/BotoConfig) with your Amazon AWS information.

## Usage

Here is a minimal example of a ``turkflow`` program:

```python
from turkflow.turkflow import *
from jinja2 import *

# create jinja2 environment using "templates" subdirectory
env = Environment(loader=PackageLoader('turkflow', 'templates'))

class TestHIT(TurkHITType):
def __init__(self):
TurkHITType.__init__(self,
"This is a test HIT",
string.split('keywords'),
description = 'test description',
duration = 600, # seconds
max_assignments = 50,
annotation = 'test', # by default, this will make turkflow look for a "test.html" jinja2 template
reward = 0.05,
env = env)

tc = TurkConnection("turkflow_test_id", "~/scratch")
hit_key = tc.createHIT(TestHIT())
results, completion_times = tc.waitForHIT(hit_key, timeout=30) # stop polling after 30 seconds
```

In a 'templates' subdirectory, we include ``base.html`` included in the turkflow repository and our own html file, ``test.html``:

```html
{% extends "base.html" %}

{% block question_content %}
<p id="name_q">What is your name?</p>
<!-- turk questions are identified by "name" so that you can gather multiple responses to the same question -->
<input type="text" name="name_q" placeholder="Clara">
{% endblock %}
```
Release History

Release History

This version
History Node

0.2.2

History Node

0.2.1

History Node

0.2

History Node

0.1.01

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
turkflow-0.2.2.tar.gz (20.4 kB) Copy SHA256 Checksum SHA256 Source Jun 6, 2013

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting