{
"info": {
"author": "Christopher Brown",
"author_email": "io@henrian.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: Apache Software License"
],
"description": "crowdflower\n===========\n\nClient library for interacting with the\n`CrowdFlower `__\n`API `__\nwith Python.\n\nInstallation\n------------\n\nInstall from `PyPI `__ with\n```setuptools`` `__:\n\n::\n\n easy_install -U crowdflower\n\nOr with ```pip`` `__:\n\n::\n\n pip install -U crowdflower\n\nOr install the latest (potentially unreleased and unstable) code from\nGitHub, using ``pip``:\n\n::\n\n git+https://github.com/twosigma/ngrid\n\nOr build the source yourself, with ``setuptools``:\n\n::\n\n git clone https://github.com/peoplepattern/crowdflower.git\n cd crowdflower\n python setup.py develop\n\nBasic usage\n-----------\n\nImport like:\n\n::\n\n import crowdflower\n\nCrowdFlower API keys are 20 characters long; the one below is just\nrandom characters. (You can find your API key at\n`make.crowdflower.com/account/user `__.)\n\n::\n\n conn = crowdflower.Connection(api_key='LbcxvIlE3x1M8F6TT5hN')\n\nThe library will default to an environment variable called\n``CROWDFLOWER_API_KEY`` if none is specified here:\n\n::\n\n conn = crowdflower.Connection()\n\nIf you want to cache job responses, like judgments, properties, and\ntags, you can initialize the connection with a cache.\n``cache='filesystem'`` is the only option currently supported, and\nserializes JSON files to ``/tmp/crowdflower/*``.\n\n::\n\n conn = crowdflower.Connection(cache='filesystem')\n\nInspecting existing jobs\n------------------------\n\nLoop through all your jobs and print the titles:\n\n::\n\n for job in conn.jobs():\n print job.properties['title']\n\nCreating a new job\n------------------\n\nCreate a new job with some new units:\n\n::\n\n data = [\n {'id': '1', 'name': 'Chris Narenz', 'gender_gold': 'male'},\n {'id': '2', 'name': 'George Henckels'},\n {'id': '3', 'name': 'Maisy Ester'},\n ]\n job = conn.upload(data)\n update_result = job.update({\n 'title': 'Gender labels',\n 'included_countries': ['US', 'GB'], # Limit to the USA and United Kingdom\n # Please note, if you are located in another country and you would like\n # to experiment with the sandbox (internal workers) then you also need\n # to add your own country. Otherwise your submissions as internal worker\n # will be rejected with Error 301 (low quality).\n 'payment_cents': 5,\n 'judgments_per_unit': 2,\n 'instructions': 'some instructions html',\n 'cml': 'some layout cml, e.g., '\n '',\n 'options': {\n 'front_load': 1, # quiz mode = 1; turn off with 0\n }\n })\n\n if 'errors' in update_result:\n print(update_result['errors'])\n exit()\n\n job.gold_add('gender', 'gender_gold')\n\nLaunch job for on-demand workers (the default):\n\n::\n\n job.launch(2)\n\nLaunch job for internal workers (sandbox):\n\n::\n\n job.launch(2, channels=['cf_internal'])\n\nCheck the status of the job:\n\n::\n\n print job.ping()\n\nClean up; delete all the jobs that were created by the above example:\n\n::\n\n for job in conn.jobs():\n if job.properties['title'] == 'Gender labels':\n print 'Deleting Job#%s' % job.id\n print job.delete()\n\nView annotations collected so far:\n\n::\n\n for row in job.download():\n print row\n\nExample\n-------\n\nSee the ``README.md`` in the\n```examples/`` `__\ndirectory for a full spam classification example using the freely\navailable `SMS Spam\nCollection `__.\n\nDebugging / Logging\n-------------------\n\nTo turn on verbose logging use the following in your script:\n\n::\n\n import logging\n logging.basicConfig(level=logging.DEBUG)\n\nMotivation\n----------\n\nThe official `Ruby\nclient `__ is hard to\nuse, which is surprising, since the CrowdFlower API is so simple.\n\nWhich is not to say the `CrowdFlower\nAPI `__\nis all ponies and rainbows, but all the documentation is there on one\npage, and it does what it says, for the most part. (Though there's more\nthat you can do, beyond what's documented.)\n\nThus, a thin Python client for the CrowdFlower API.\n\nReferences\n----------\n\nThe CrowdFlower blog is the definitive (but incomplete) source for API\ndocumentation:\n\n- `The main API documentation\n page `__\n - Last Updated: Jul 31, 2014\n- `More info on the\n API `__\n - Last Updated: Jul 31, 2014\n- `Details on using API\n webhooks `__\n - Last Updated: Jul 25, 2014\n- `Rest\n API `__\n - Last Updated: Aug 11, 2014\n- `API Request\n Examples `__\n - Last Updated: Aug 11, 2014\n- `CML (CrowdFlower Markup\n Language) `__\n - Last Updated: Aug 12, 2014\n\nThe source code for the official\n`ruby-crowdflower `__\nproject is also helpful in some cases.\n\nThis package uses `kennethreitz `__'s\n`Requests `__ to\ncommunicate with the CrowdFlower API over HTTP. Requests is `Apache2\nlicensed `__.\n\nSupport\n-------\n\nFound a bug? Want a new feature? `File an\nissue `__!\n\nContributing\n------------\n\nWe love open source and working with the larger community to make our\ncodebase even better! If you have any contributions, please fork this\nrepository, commit your changes to a new branch, and then submit a pull\nrequest back to this repository (peoplepattern/crowdflower). To expedite\nmerging your pull request, please follow the stylistic conventions\nalready present in the repository. These include:\n\n- Adhere to PEP8\n- We're not super strict on every single PEP8 convention, but we have a\n few hard requirements:\n\n - Four-space indentation\n - No tabs\n - No semicolons\n - No wildcard imports\n\n- No trailing whitespace\n- Use docstrings liberally\n\nThe Apache License 2.0 contains a clause covering the `Contributor\nLicense\nAgreement `__.\n\nAuthors\n-------\n\n- `Christopher Brown `__\n\nLicense\n-------\n\nCopyright 2014 People Pattern Corporation\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may\nnot use this file except in compliance with the License. You may obtain\na copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"description_content_type": null,
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/peoplepattern/crowdflower",
"keywords": "crowdflower crowdsourcing api client",
"license": "Copyright 2014 People Pattern Corporation\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"maintainer": "",
"maintainer_email": "",
"name": "crowdflower",
"package_url": "https://pypi.org/project/crowdflower/",
"platform": "",
"project_url": "https://pypi.org/project/crowdflower/",
"project_urls": {
"Homepage": "https://github.com/peoplepattern/crowdflower"
},
"release_url": "https://pypi.org/project/crowdflower/0.1.5/",
"requires_dist": null,
"requires_python": "",
"summary": "CrowdFlower API - Python client",
"version": "0.1.5"
},
"last_serial": 3228740,
"releases": {
"0.0.10": [
{
"comment_text": "",
"digests": {
"md5": "d0493331ffb5862638823a10d47c3da4",
"sha256": "91ab29ae9c7c1fc6d009cce3ad801cf75e69fd3eeff4194f7756830242a2697e"
},
"downloads": -1,
"filename": "crowdflower-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "d0493331ffb5862638823a10d47c3da4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9750,
"upload_time": "2014-07-28T19:34:57",
"url": "https://files.pythonhosted.org/packages/28/23/2cef057a504f5b64a9e06252dde2c3c8752e1cfbe53367abbca4cd81135c/crowdflower-0.0.10.tar.gz"
}
],
"0.0.11": [
{
"comment_text": "",
"digests": {
"md5": "047c78c02a5fb59e57f4011be3c7fc91",
"sha256": "c762f42922ddc638dcbfd8a6bc5a4ba2fc61fcfc203d5294bbc2ebf561b68e04"
},
"downloads": -1,
"filename": "crowdflower-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "047c78c02a5fb59e57f4011be3c7fc91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9851,
"upload_time": "2014-07-29T21:32:53",
"url": "https://files.pythonhosted.org/packages/56/9f/97e4b8b07a0f04ad3f428948730c6e2e9ff2157b7f2864f3c03a9e3059e0/crowdflower-0.0.11.tar.gz"
}
],
"0.0.12": [
{
"comment_text": "",
"digests": {
"md5": "efba28d6080109f078543afd19b22abb",
"sha256": "6b6cbedfc911afbd6bbe790298d865edec6c17923b440b9382a7189e03ce9dc6"
},
"downloads": -1,
"filename": "crowdflower-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "efba28d6080109f078543afd19b22abb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11754,
"upload_time": "2014-08-05T21:51:52",
"url": "https://files.pythonhosted.org/packages/2d/1d/66a6d4baf84093fa27d0c4b77c2aa6b737437a399ac4c3f606e88935d651/crowdflower-0.0.12.tar.gz"
}
],
"0.0.2": [
{
"comment_text": "",
"digests": {
"md5": "bb22b42933fa67cd6ed98f670e326a25",
"sha256": "de1e8e2f6d805bb561a910b9ddaeb55d22a6079cd2988361a9fbd1596b98b77c"
},
"downloads": -1,
"filename": "crowdflower-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "bb22b42933fa67cd6ed98f670e326a25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4736,
"upload_time": "2014-06-04T19:49:31",
"url": "https://files.pythonhosted.org/packages/26/87/46cf25019148a553ed15f83800096e1cb71536f7b76b0ad3ee479ec55534/crowdflower-0.0.2.tar.gz"
}
],
"0.0.3": [
{
"comment_text": "",
"digests": {
"md5": "1288d8164fc3f8bd0d39fc84fe80a172",
"sha256": "c26952b725e19216f7a24747f819b4f63e06639db3382392bd24588a28dc278c"
},
"downloads": -1,
"filename": "crowdflower-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "1288d8164fc3f8bd0d39fc84fe80a172",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4732,
"upload_time": "2014-06-04T19:50:52",
"url": "https://files.pythonhosted.org/packages/fe/72/f383096b0a196f15ebb01710dd42077dbd29cd8046ac23e3f34baec295c3/crowdflower-0.0.3.tar.gz"
}
],
"0.0.4": [
{
"comment_text": "",
"digests": {
"md5": "d047d62420b7529133ad42964d552d5e",
"sha256": "6ac466ccff55b87d58cbb4554bfa2c2288310ebc103f4852b8787b260c05d7a4"
},
"downloads": -1,
"filename": "crowdflower-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "d047d62420b7529133ad42964d552d5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6607,
"upload_time": "2014-06-09T22:54:13",
"url": "https://files.pythonhosted.org/packages/bf/a5/cb4be934fa385006c333456160c9617e4fe5ba023da88569e3a2e5eadec1/crowdflower-0.0.4.tar.gz"
}
],
"0.0.5": [
{
"comment_text": "",
"digests": {
"md5": "62063c8e60113053cdc99b973eb2ca68",
"sha256": "372e0a8c26df39f7657b36879f30621e967a2fd3f93832238cc89a218d820f5f"
},
"downloads": -1,
"filename": "crowdflower-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "62063c8e60113053cdc99b973eb2ca68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7214,
"upload_time": "2014-06-22T16:12:30",
"url": "https://files.pythonhosted.org/packages/ee/b0/5ae308130b0053c3ca391b2190fefcd6c686a085e0e5c77382d149f0fd50/crowdflower-0.0.5.tar.gz"
}
],
"0.0.6": [
{
"comment_text": "",
"digests": {
"md5": "e2ff1a40bc8171c8841b3e193794f51d",
"sha256": "ae148167072ee28c72932efcaabe4e55947d8237fea67b71f34bd63a9bb1ec34"
},
"downloads": -1,
"filename": "crowdflower-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "e2ff1a40bc8171c8841b3e193794f51d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7369,
"upload_time": "2014-06-27T15:02:59",
"url": "https://files.pythonhosted.org/packages/e4/2f/5665aaad317f8aac833894476ada374b5483a0560c9f557a61831d98b00d/crowdflower-0.0.6.tar.gz"
}
],
"0.0.7": [
{
"comment_text": "",
"digests": {
"md5": "5fce1e1e1d4764584cddf5b9d4005c7e",
"sha256": "82dd1c891a1bf87c00cd7173d4efb57573251cc4bef9517179b04d31519d44ac"
},
"downloads": -1,
"filename": "crowdflower-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "5fce1e1e1d4764584cddf5b9d4005c7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7579,
"upload_time": "2014-07-01T21:34:21",
"url": "https://files.pythonhosted.org/packages/ac/9e/4cf1c94bdd26e13fe3488d7386a393e67d7e4a855def3520bf95020b19c8/crowdflower-0.0.7.tar.gz"
}
],
"0.0.8": [
{
"comment_text": "",
"digests": {
"md5": "2e58e30bb4013a93a2632496ad4bf34a",
"sha256": "e7604975f7c1f2089a77c91856bd5894240a98ce1a1544f1a24765a329b62409"
},
"downloads": -1,
"filename": "crowdflower-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "2e58e30bb4013a93a2632496ad4bf34a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8682,
"upload_time": "2014-07-08T20:58:38",
"url": "https://files.pythonhosted.org/packages/fb/d9/4003086cd49cf896a7dd018904eeeb88020d81c1151fb53b034f81caa37e/crowdflower-0.0.8.tar.gz"
}
],
"0.0.9": [
{
"comment_text": "",
"digests": {
"md5": "2f30a1b4e94f3271338f5a7192c6dd12",
"sha256": "1a3df5d964cd01e33a10b01102284ddf105047886da1bf7d2afd7b655c1f05a4"
},
"downloads": -1,
"filename": "crowdflower-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "2f30a1b4e94f3271338f5a7192c6dd12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9235,
"upload_time": "2014-07-16T19:26:18",
"url": "https://files.pythonhosted.org/packages/f5/9b/398154ed391ee8b029b984d5a78d5f3c7dce367810a582f7939100bbb375/crowdflower-0.0.9.tar.gz"
}
],
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "d554d1b6e451786fe334e25178e4e8f6",
"sha256": "4c279420a9408f4ef7e778b3c49c005cff441235522ee7140f6bb426e81a049a"
},
"downloads": -1,
"filename": "crowdflower-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d554d1b6e451786fe334e25178e4e8f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12437,
"upload_time": "2014-08-11T18:09:04",
"url": "https://files.pythonhosted.org/packages/21/18/8de97765e0386d5025df19bf20ccada5029efc57d31064880e30d5dc58bd/crowdflower-0.1.0.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "b8cec37702d89fea5432bbaed3f1a76c",
"sha256": "d4cebac719a41f8d9a5c26d7e19134ec3980556b86823e135c1c01ad3933716e"
},
"downloads": -1,
"filename": "crowdflower-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b8cec37702d89fea5432bbaed3f1a76c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12732,
"upload_time": "2014-08-22T19:53:46",
"url": "https://files.pythonhosted.org/packages/f0/f3/16f2190fa699e02cad44fe2fd5badb88d87848d8b92fb786c6eecf8db2d7/crowdflower-0.1.1.tar.gz"
}
],
"0.1.2": [
{
"comment_text": "",
"digests": {
"md5": "39439b7eca526b047b6530e8aba78420",
"sha256": "e439c73713b4b944b6df9eaa1d1a04dd2e4fce25cc8062833826ce48d32d53db"
},
"downloads": -1,
"filename": "crowdflower-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "39439b7eca526b047b6530e8aba78420",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12789,
"upload_time": "2014-08-22T21:45:30",
"url": "https://files.pythonhosted.org/packages/ce/11/a9f291b75192241a75e793b6c0faf0240de4126caac92d3228b8a2c40422/crowdflower-0.1.2.tar.gz"
}
],
"0.1.3": [
{
"comment_text": "",
"digests": {
"md5": "74199b60b48378a100cbfa1fa5aed3d7",
"sha256": "596889c67ea6c9cf1fe0c8e1fab7d0ac7252c3864dee97584b2afa8e72ac6ba6"
},
"downloads": -1,
"filename": "crowdflower-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "74199b60b48378a100cbfa1fa5aed3d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13505,
"upload_time": "2015-05-31T19:05:47",
"url": "https://files.pythonhosted.org/packages/d7/e4/1a6719d3c9c00097fbaef15e9dc91f37999c30a1c5caf5d9dfe24d2c4200/crowdflower-0.1.3.tar.gz"
}
],
"0.1.4": [
{
"comment_text": "",
"digests": {
"md5": "fc621767c9e51ae5890c4e1c075f545f",
"sha256": "a5f41d53d123bada692e86dc7a6e6bb1ada78d641051f1867703670abc40e601"
},
"downloads": -1,
"filename": "crowdflower-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "fc621767c9e51ae5890c4e1c075f545f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13696,
"upload_time": "2015-10-31T18:34:28",
"url": "https://files.pythonhosted.org/packages/be/ff/0baf4bd62c1ba3f4c02b470fe9e127e0537811eed52c5ca7c7f5168b40e5/crowdflower-0.1.4.tar.gz"
}
],
"0.1.5": [
{
"comment_text": "",
"digests": {
"md5": "e2c04832565ab9650d0d700a402e3aee",
"sha256": "31955ead5a66fb6d1d49da82f005700a986858fa3df9f5c408e15953f743db1b"
},
"downloads": -1,
"filename": "crowdflower-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "e2c04832565ab9650d0d700a402e3aee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13942,
"upload_time": "2017-10-05T19:30:47",
"url": "https://files.pythonhosted.org/packages/b8/02/fd855be5dba706d8fe8698614d8ab251d12959753ddb9e8a66f596393b77/crowdflower-0.1.5.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e2c04832565ab9650d0d700a402e3aee",
"sha256": "31955ead5a66fb6d1d49da82f005700a986858fa3df9f5c408e15953f743db1b"
},
"downloads": -1,
"filename": "crowdflower-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "e2c04832565ab9650d0d700a402e3aee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13942,
"upload_time": "2017-10-05T19:30:47",
"url": "https://files.pythonhosted.org/packages/b8/02/fd855be5dba706d8fe8698614d8ab251d12959753ddb9e8a66f596393b77/crowdflower-0.1.5.tar.gz"
}
]
}