{ "info": { "author": "Jon Atkinson", "author_email": "jon@wearefarm.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7" ], "description": "gathercontent\n=============\n\n\nThis is a very simple API wrapper for GatherContent in Python. For more information about the GatherContent API, have a look at:\n\nhttp://help.gathercontent.com/developer-api/\n\n\nDependencies\n------------\n\nYou'll need `requests`. If you're installing via Pypi/pip, this should be installed automatically. If you need to install it manually, this was developed against `requests==2.5.1`, so it's probably best to use that.\n\n\nUsage\n-----\n\nThis module exposes all documented GatherContent API methods. Assuming the URL schema doesn't change, it should work with future API versions, too, as long as the URI's are all prefixed with `get_`. Right now, I've tested this with the following API methods:\n\n- get_me \u2013 logged in user\n- get_users \u2013 all visible users for given API key\n- get_user (id) \u2013 user with specified id\n- get_my_group \u2013 group that API user belongs to\n- get_groups \u2013 all visible groups for given API key\n- get_group (id) \u2013 group with specified id\n- get_projects \u2013 all visible projects for given API key\n- get_project (id) \u2013 project with specified id\n- get_page (id) \u2013 page with specified id\n- get_pages_by_project (id) \u2013 all pages belonging to project with specified id\n- get_file (id) \u2013 file with specified id\n- get_files_by_project (id) \u2013 all files belonging to project with specified id\n- get_files_by_page (id) \u2013 all files belonging to page with specified id\n- get_custom_state (id) \u2013 custom state with specified id\n- get_custom_states_by_project (id)\n\nThe API takes the JSON responses and converts them into Python dictionaries. For example:\n\n\t>>> from gathercontent import GatherContent\n\t>>> gc = GatherContent(api_key=\"your-api-key-here\", account_name=\"your-account-name-here\")\n\t>>> gc.get_users()\n\t>>> users = gc.get_users()\n\t>>> type(users)\n\t\n\t>>> users\n\t{u'users': [{u'first_name': u'Example', u'last_name': u'User', u'created_at': u'2014-10-14 10:33:08', u'updated_at': u'2015-02-04 11:30:01', u'email': u'person@example.com', u'timezone': u'UTC', u'group_id': u'29122', u'id': u'75580'}], u'success': True}\n\t>>> gc.get_user(id=75580)\n\t{u'user': {u'first_name': u'Example', u'last_name': u'User', u'created_at': u'2014-10-14 10:33:08', u'updated_at': u'2015-02-04 11:30:01', u'email': u'person@example.com', u'timezone': u'UTC', u'group_id': u'29122', u'id': u'75580'}, u'success': True}\n\n\nLicense\n-------\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 FARM Digital Ltd.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n\n\nCredits\n-------\n\nThanks to everyone at [FARM Digital](http://www.wearefarm.com/) for the code review before we published this.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/wearefarm/gathercontent", "keywords": "gather content gathercontent", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "gathercontent", "package_url": "https://pypi.org/project/gathercontent/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/gathercontent/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://bitbucket.org/wearefarm/gathercontent" }, "release_url": "https://pypi.org/project/gathercontent/0.2/", "requires_dist": null, "requires_python": null, "summary": "A very simple API wrapper for Gather Content", "version": "0.2" }, "last_serial": 1409537, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "c6d9641debbe4b5262fafbdacd78a2d7", "sha256": "001b7677381380c53945313a47aaf808d9a742c2b220b17ffac39aab4bbbcc67" }, "downloads": -1, "filename": "gathercontent-0.1.tar.gz", "has_sig": false, "md5_digest": "c6d9641debbe4b5262fafbdacd78a2d7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3476, "upload_time": "2015-02-04T14:30:49", "url": "https://files.pythonhosted.org/packages/3c/b9/c69e66b33ec80eb8edc603320aa06ff120229d115cbef4bf5ac01b66264f/gathercontent-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "7a13fef369011af7a932af4602f3b197", "sha256": "6275f2ce6dd42235278a93b76609879a7738fcd63238b10d800377a2f2801515" }, "downloads": -1, "filename": "gathercontent-0.2.tar.gz", "has_sig": false, "md5_digest": "7a13fef369011af7a932af4602f3b197", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3741, "upload_time": "2015-02-04T15:21:32", "url": "https://files.pythonhosted.org/packages/4d/fd/1728eb4e256fb4c663322908c14b62f04561db037e199a48a60354e1af61/gathercontent-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7a13fef369011af7a932af4602f3b197", "sha256": "6275f2ce6dd42235278a93b76609879a7738fcd63238b10d800377a2f2801515" }, "downloads": -1, "filename": "gathercontent-0.2.tar.gz", "has_sig": false, "md5_digest": "7a13fef369011af7a932af4602f3b197", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3741, "upload_time": "2015-02-04T15:21:32", "url": "https://files.pythonhosted.org/packages/4d/fd/1728eb4e256fb4c663322908c14b62f04561db037e199a48a60354e1af61/gathercontent-0.2.tar.gz" } ] }