The CrowdRouter is a developer framework for designing crowdwork applications.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
crowdrouter
example
.gitignore
LICENSE
README.md
setup.cfg
setup.py
test_classes.py
tests.py

README.md

Stories in Ready

crowdrouter

Tired of having messy crowdsourcing code? Ever thought about swapping in a new task or workflow for an old one but felt reluctant about how much refactoring that would cause? Ever wish you could separate crowdsourcing from your app in general?

Enter the crowdrouter, a developer framework for architecting tasks to the crowd. Plug it in to your favorite Python web framework and go. Implement crowd workflows and tasks as first-class objects, and then route them using the CrowdRouter object. Create task pipelines that connect tasks together to provide a fluid tasking environment.

Basically, the crowdrouter is designed to get you thinking about crowdsourcing as a module rather than spaghetti code.

How it works

There are three components:

CrowdRouter: guards and passes client requests, keeping track of crowd statistics such as number of allowable requests, whitelists and blacklists to check against, task counts, and more. Your own CrowdRouter instance defines which WorkFlow instances it can pass requests to.

WorkFlow: handles the template for how crowdwork is performed. For example, Task A needs to always happen before Task B. Task C can be executed by anyone, anytime. Task D, however, requires authentication. Multiple WorkFlows instances means that your web application needs coordinated crowdsourcing for various use cases.

Task: encapsulates a unit of crowdwork. Each Task instance defines a request and response action, mirroring the HTTP GET and POST requests on the web. Use a Task to define what template to serve back to the client, data to validate or create via a database call, or remote API to call. Your crowdwork belongs inside Tasks.

Here's a simple CrowdRouter:

class MyCrowdRouter(AbstractCrowdRouter):
	def __init__(self):
		self.workflows = [MatchingWorkFlow] #Put in workflow classes here.

	@crowdrouter
	def route(self, crowd_request, workflow):
		return workflow.run(crowd_request)

Here's a simple WorkFlow that accepts any request and performs the right task:

class MatchingWorkFlow(AbstractWorkFlow):
	def __init__(self):
		tasks = [MatchTask, ConfirmMatchTask] #Put Task classes here.

	@workflow
	def run(self, task):
		return task.execute() #Execute the task normally.

And here's the MatchTask:

class MatchTask(AbstractTask):
	@task
	def get(self):
		return {"status": "OK", "msg": "TEST [GET]"}
	@task
	def post(self):
		return {"status": "OK", "msg": "TEST [POST]"}

That's it! Just globally initialize crowdrouter = MyCrowdRouter() and you're good to go. Try putting your CrowdRouter instance in various controller actions and re-organize those actions into Task instances:

def perform_task(request, task_name):
	...
	crowdrouter.route("MatchingWorkFlow", task_name, request, session)
	...

The crowdrouter will do the work in converting these arguments into a CrowdRequest that will get properly routed to the specified Task in the specified WorkFlow.

##Contributing Please do. There's a Waffle board set up that has a few tasks, but more conceptualization/architecting is always appreciated. Just ping me.

##Questions? Email me at mario dot barrenechea at colorado dot edu.