{ "info": { "author": "Adam Yala", "author_email": "adam@adamyala.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Build Tools" ], "description": "# buttercms-python\n\nPython Library for ButterCMS API. \n\n## Documentation\n\nFor a comprehensive list of examples, check out the [API documentation](https://buttercms.com/docs/api/).\n\n## Jump to:\n\n* [Pages](#pages)\n* [Content Fields](#content-fields)\n* [Posts](#posts)\n* [Authors](#authors)\n* [Categories](#categories)\n* [Feeds](#feeds)\n\n## Installation\n\nInstall from PyPi using [pip](http://www.pip-installer.org/en/latest/), a\npackage manager for Python.\n\n pip install buttercms-python\n\n\n## Usage\n\nGetting started with the ButterCMS API couldn't be easier. Use your authorization token to create a ButterCMS client.\n\n```python\nfrom butter_cms import ButterCMS\n\nauth_token = \"XXXXXXXXXXXXXXXXXXX\"\nclient = ButterCMS(auth_token)\n```\n\nAll methods return dictionaries. The data can be navigated using keys and indexes like the example below.\n\n```python\nresponse = client.posts.all()\n\nposts = response['data'] \n# posts now contains a list of post dictionaries\n\nmy_post = posts[0]\n# my_post contains the first returned post\n\nprint(my_post)\n# {\n# \"url\": \"http://www.example.com/blog/this-is-a-blog-post\",\n# \"created\": \"2015-06-12T13:59:32.441289Z\",\n# \"published\": \"2015-06-12T00:00:00Z\",\n# ...\n# }\n```\n\n### Pages\n\nThe Page's `.all()` and `.get()` methods accept an optional `params` to add additional data to the response.\n\n```python\nclient.pages.all('news')\n\n# Optional params\nclient.pages.all('news', {'foo': 'bar'})\n```\n\n\n```python\nclient.pages.get('news', 'hello-world')\n\n# Optional params\nclient.pages.get('news', 'hello-world', {'foo': 'bar'})\n```\n\n\n[To Top](#buttercms-python)\n\n\n### Content Fields\n\nThe Content Field's .get() method accepts an optional `params` to add additional data to the response.\n\n```python\nclient.content_fields.get(['homepage_headline', 'homepage_title'])\n\n# Localization\nclient.content_fields.get(['homepage_headline', 'homepage_title'], {'locale': 'en'})\n\n# Test Mode \nclient.content_fields.get(['homepage_headline', 'homepage_title'], {'test': 1})\n```\n\n[To Top](#buttercms-python)\n\n\n### Blog Engine\n\n#### Posts\n\n```python\nclient.posts.all({'page_size': 3, 'page': 1, 'exclude_body': 'true'})\n```\n\n\n```python\nclient.posts.get('hello-world')\n```\n\n\n```python\nclient.posts.search('query', {'page': 1, 'page_size': 10})\n```\n\n#### Authors\n\nThe Author's `.all()` and `.get()` methods accept an optional `params` to add additional data to the response.\n\n* `{'include':'recent_posts'}`: Adds each author's posts under the `recent_posts` key in that author's returned dictionary\n\n```python\nclient.authors.all()\nclient.authors.all({'include':'recent_posts'})\n```\n\n\n```python\nclient.authors.get('jennifer-smith')\nclient.authors.get('jennifer-smith', {'include':'recent_posts'})\n```\n\n\n[To Top](#buttercms-python)\n\n#### Categories\n\nThe Category's `.all()` and `.get()` methods accept an optional `params` to add additional data to the response.\n\n* `{'include':'recent_posts'}`: Adds posts tagged with that category under the `recent_posts` key in that category's returned dictionary\n\n```python\nclient.categories.all()\nclient.categories.all({'include':'recent_posts'})\n```\n\n\n```python\nclient.categories.get('product-updates')\nclient.categories.get('product-updates', {'include':'recent_posts'})\n```\n\n\n[To Top](#buttercms-python)\n\n\n#### Tags\n\nThe Tag's `.all()` and `.get()` methods accept an optional `params` to add additional data to the response.\n\n* `{'include':'recent_posts'}`: Adds posts tagged with that tag under the `recent_posts` key in that tag's returned dictionary\n\n```python\nclient.tags.all()\nclient.tags.all({'include':'recent_posts'})\n```\n\n\n```python\nclient.tags.get('product-updates')\nclient.tags.get('product-updates', {'include':'recent_posts'})\n```\n\n\n[To Top](#buttercms-python)\n\n#### Feeds\n\n```python\nclient.feeds.get('rss')\n```\n\n\n```python\nclient.feeds.get('atom')\n```\n\n\n```python\nclient.feeds.get('sitemap')\n```\n\n\n[To Top](#buttercms-python)\n\n\n\n### Other\n\nView Python [Blog engine](https://buttercms.com/python-blog-engine/) and [Full CMS](https://buttercms.com/python-cms/) for other examples of using ButterCMS with Python.\n\n### Tests\n\nTo run tests:\n\n```python\npython -m unittest butter_cms/unit_tests.py\n```\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/buttercms/buttercms-python/tarball/0.1", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/buttercms/buttercms-python", "keywords": "foo,bar,baz", "license": "", "maintainer": "", "maintainer_email": "", "name": "buttercms-python", "package_url": "https://pypi.org/project/buttercms-python/", "platform": "", "project_url": "https://pypi.org/project/buttercms-python/", "project_urls": { "Download": "https://github.com/buttercms/buttercms-python/tarball/0.1", "Homepage": "https://github.com/buttercms/buttercms-python" }, "release_url": "https://pypi.org/project/buttercms-python/1.1/", "requires_dist": [ "requests" ], "requires_python": "", "summary": "API First Blogging and CMS platform built for developers", "version": "1.1" }, "last_serial": 3841853, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "da33adb03477446b3824292bcd799437", "sha256": "47cba362dc284aa5ff2405b780f0a5ff5417ee6e534480cc40b6ccb55f780697" }, "downloads": -1, "filename": "buttercms_python-0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "da33adb03477446b3824292bcd799437", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11155, "upload_time": "2016-07-16T04:16:54", "url": "https://files.pythonhosted.org/packages/19/af/12c64a4ab834a4c40ca2b0487d2205d19b656fdd5eb0777b4c534575d16d/buttercms_python-0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0220f2bd866039424516467052a30a72", "sha256": "39a4d0ef743dad1a5dd763a1334bb0048139aeb75dbe97173766ec9be1576c39" }, "downloads": -1, "filename": "buttercms-python-0.1.tar.gz", "has_sig": false, "md5_digest": "0220f2bd866039424516467052a30a72", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7033, "upload_time": "2016-07-16T04:16:56", "url": "https://files.pythonhosted.org/packages/36/aa/2934f25c99a6b6b48b0d9c96bba3dcc6b7a8670512f26ff2cad20019f9da/buttercms-python-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "bf6ff9173e65f644c7591f1d025763ee", "sha256": "b055b386e333a6ab7d73ff8566112e409e765e27bb562c335dc025b213ea5d9b" }, "downloads": -1, "filename": "buttercms_python-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "bf6ff9173e65f644c7591f1d025763ee", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11312, "upload_time": "2016-07-18T14:17:43", "url": "https://files.pythonhosted.org/packages/48/c2/21047d8f51a2ad7ed8e61e8e6b15bb151716221d5fe34639f9a6b358e582/buttercms_python-0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6e3066aab501ecea044fdd3184291fb2", "sha256": "3ea7a2fd47685f71cb343016c5c816827d049fdf2a39bac4d0ed6b38123fe5d1" }, "downloads": -1, "filename": "buttercms-python-0.2.tar.gz", "has_sig": false, "md5_digest": "6e3066aab501ecea044fdd3184291fb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7026, "upload_time": "2016-07-18T14:17:39", "url": "https://files.pythonhosted.org/packages/82/d2/2ac7105317409d9acaa9552dfb13fcdb67aedf406dae89da423725c58343/buttercms-python-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "d34947241e9f1f76dca901ab038c0949", "sha256": "fbdc10f33cfa3ebadf267a04f2832033e88cabdd48637a20353162269a2e2cdb" }, "downloads": -1, "filename": "buttercms_python-0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d34947241e9f1f76dca901ab038c0949", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11298, "upload_time": "2016-09-14T13:31:53", "url": "https://files.pythonhosted.org/packages/bd/86/24554fc5fb9edb75f1a12a13e337004e1ccf41deead36005cc8ed9b7dcb7/buttercms_python-0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cd3d341d54df83d1be6507b1b18bbc45", "sha256": "9a32906c67bb878f924ac48dc4afc76286fbcd3ce247f1fd8041f6608530bd90" }, "downloads": -1, "filename": "buttercms-python-0.3.tar.gz", "has_sig": false, "md5_digest": "cd3d341d54df83d1be6507b1b18bbc45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7021, "upload_time": "2016-09-14T13:31:55", "url": "https://files.pythonhosted.org/packages/24/4d/cd564d94decd94757218656000346f3dfc9cda1aed3e7ace9ea7fa323161/buttercms-python-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "82581a0cc58476570b7ffcca3e1bc9f3", "sha256": "bff09a2a1b25a9c45066a751d1d1ecac232fafef7c4102e45b14cf87928d2caa" }, "downloads": -1, "filename": "buttercms_python-0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "82581a0cc58476570b7ffcca3e1bc9f3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11797, "upload_time": "2016-11-08T14:45:33", "url": "https://files.pythonhosted.org/packages/fa/e5/706860d2f57aa6c56ce14739274b16c5054a68f35e9bf5c5402c11569a3e/buttercms_python-0.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "53297bc5db3972b9b569ecfe9a26cb21", "sha256": "c1590c6c2567f8c7458f6f5079405463dd58ba92f982760a252472316e71ad90" }, "downloads": -1, "filename": "buttercms-python-0.4.tar.gz", "has_sig": false, "md5_digest": "53297bc5db3972b9b569ecfe9a26cb21", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7233, "upload_time": "2016-11-08T14:45:30", "url": "https://files.pythonhosted.org/packages/c5/ff/766134cad891e7b46d935f7f9ecbbb6dbebdfef75b7cd666db40b6f312bb/buttercms-python-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "d3197a2d927a5a1d81e1e9efeef5d084", "sha256": "ede565a1b91ecbc9bac399c0871695b0bcfa9731c5993926447ee1b6b343bae8" }, "downloads": -1, "filename": "buttercms_python-0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d3197a2d927a5a1d81e1e9efeef5d084", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8378, "upload_time": "2016-11-21T14:49:34", "url": "https://files.pythonhosted.org/packages/bd/37/4edde74429b6869cdf7f296133aec048453f217fc3cd27c7e28dc6d66f71/buttercms_python-0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "617c037cd7692102f3f59103a39c578d", "sha256": "27674793f0f450b5445ba202b809555fdec03506bd44a91fcfd43da966f15dd2" }, "downloads": -1, "filename": "buttercms-python-0.5.tar.gz", "has_sig": false, "md5_digest": "617c037cd7692102f3f59103a39c578d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5001, "upload_time": "2016-11-21T14:49:31", "url": "https://files.pythonhosted.org/packages/e4/0f/37b7b7da64fa8e02af0e97cc912b7f0c6c97adba39a53e2fc08d44b57c8b/buttercms-python-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "4cfd2dc83604f7a07bf69345be12ce7d", "sha256": "ba6efe81f9718e39b46284550e6e0e94a3b79dafd6fc032a67fc1104185b520f" }, "downloads": -1, "filename": "buttercms_python-0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4cfd2dc83604f7a07bf69345be12ce7d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8378, "upload_time": "2017-03-06T20:54:52", "url": "https://files.pythonhosted.org/packages/35/2b/e9387227fdb4a7e05bb4ba99f1e9b4137ac1ef2e53469fbdad4979b20626/buttercms_python-0.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5bfe5e9022fa2dcdccc589331665077a", "sha256": "a0cddff5f1d21a7c56b1462bd113f0196ed225373ceeaad7513a7f8b4a8be7f7" }, "downloads": -1, "filename": "buttercms-python-0.6.tar.gz", "has_sig": false, "md5_digest": "5bfe5e9022fa2dcdccc589331665077a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5003, "upload_time": "2017-03-06T20:54:50", "url": "https://files.pythonhosted.org/packages/fa/2f/1f93c395bafdd98a82e62a4ad3d34ac07a76baf52ce3ace6710b50f788b2/buttercms-python-0.6.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "290b56751e98b57f2d4c5b9602d5cb44", "sha256": "0c78ae2cb375c9ddcc66ccc4a1a1b29e941dac34b69877b85f190f1c47a36e67" }, "downloads": -1, "filename": "buttercms_python-0.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "290b56751e98b57f2d4c5b9602d5cb44", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8382, "upload_time": "2017-03-06T21:07:48", "url": "https://files.pythonhosted.org/packages/8f/1e/194520635693db88dd8e9555f8aeb43e0646c87f1476dbc94cc63645476e/buttercms_python-0.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b2c31f55f6e664743d793cacfa15a334", "sha256": "1382a90d8bd04c2dfeac90812b35eaac55cf00632b97f008dbd9525a0578cb54" }, "downloads": -1, "filename": "buttercms-python-0.7.tar.gz", "has_sig": false, "md5_digest": "b2c31f55f6e664743d793cacfa15a334", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4993, "upload_time": "2017-03-06T21:07:44", "url": "https://files.pythonhosted.org/packages/80/1b/1371c2950026b34c8f33cca18ad46efb2b432d9f6fcc137e3919178db910/buttercms-python-0.7.tar.gz" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "a8a86263699573afd24818ffdbc476ae", "sha256": "d812986f9046fb48cb981b612dd244b01127ca73276df44fa24bbcecc027b53b" }, "downloads": -1, "filename": "buttercms_python-0.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a8a86263699573afd24818ffdbc476ae", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9412, "upload_time": "2017-11-09T19:48:34", "url": "https://files.pythonhosted.org/packages/70/90/76bbb198464fa347bb2804203a470e43a15c819b8944792079cef661d148/buttercms_python-0.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "eedd619e7d32e929f7e4b4932ead9ba5", "sha256": "d50d38a27d1408efa1efcd6b3a98447b9195e06ec5dfe2e69643b7bf674fbcdb" }, "downloads": -1, "filename": "buttercms-python-0.8.tar.gz", "has_sig": false, "md5_digest": "eedd619e7d32e929f7e4b4932ead9ba5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5428, "upload_time": "2017-11-09T19:48:31", "url": "https://files.pythonhosted.org/packages/10/2b/c15bec80625961e1714229180b0524d068f63f872d80d7881d15c6c948a2/buttercms-python-0.8.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "32137883790f10fee61fabbccb6f0702", "sha256": "fe3aee09fed6d6f782780cd34f3aa19d41188e3063cdb812a637952adb668896" }, "downloads": -1, "filename": "buttercms_python-1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "32137883790f10fee61fabbccb6f0702", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9529, "upload_time": "2017-11-09T20:34:13", "url": "https://files.pythonhosted.org/packages/47/d8/386189160eca622568af51a293903c6085bb9b4c5ba9497b15f5bd155a51/buttercms_python-1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86d40f6e050b84fe60fbfd12e968a347", "sha256": "461859fa6930cc4201dae6685e79d49c8022d351aac379c50cc7576667f9974f" }, "downloads": -1, "filename": "buttercms-python-1.0.tar.gz", "has_sig": false, "md5_digest": "86d40f6e050b84fe60fbfd12e968a347", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5537, "upload_time": "2017-11-09T20:34:12", "url": "https://files.pythonhosted.org/packages/92/f9/6df183e9828ae1fa99708b196aca7d1103ce7fb0040117d7ac1b2a7bd4a9/buttercms-python-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "a9941bc07bd2473c15bc2c988778ad4c", "sha256": "4d795fa34fbc7d3c20351401f55723831f0057b1b0c982c71f1e0d6c12abd598" }, "downloads": -1, "filename": "buttercms_python-1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a9941bc07bd2473c15bc2c988778ad4c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9565, "upload_time": "2018-05-07T18:56:37", "url": "https://files.pythonhosted.org/packages/98/1a/2b4fc3705e242462ab1f2a1b90bad68feca27199a2a6e684542392feab1c/buttercms_python-1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2f3fca8fa3817992567c006051771491", "sha256": "c4ca7328eaa3c9a2f482fc8abe88f123dcc25bfec99d4a5acec9d6a5e9ba3e64" }, "downloads": -1, "filename": "buttercms-python-1.1.tar.gz", "has_sig": false, "md5_digest": "2f3fca8fa3817992567c006051771491", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5577, "upload_time": "2018-05-07T18:56:39", "url": "https://files.pythonhosted.org/packages/b6/d1/821a91bafedbc4100357d8fadf93ba422e7ff06cf9b697b573b73422fefa/buttercms-python-1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a9941bc07bd2473c15bc2c988778ad4c", "sha256": "4d795fa34fbc7d3c20351401f55723831f0057b1b0c982c71f1e0d6c12abd598" }, "downloads": -1, "filename": "buttercms_python-1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a9941bc07bd2473c15bc2c988778ad4c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9565, "upload_time": "2018-05-07T18:56:37", "url": "https://files.pythonhosted.org/packages/98/1a/2b4fc3705e242462ab1f2a1b90bad68feca27199a2a6e684542392feab1c/buttercms_python-1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2f3fca8fa3817992567c006051771491", "sha256": "c4ca7328eaa3c9a2f482fc8abe88f123dcc25bfec99d4a5acec9d6a5e9ba3e64" }, "downloads": -1, "filename": "buttercms-python-1.1.tar.gz", "has_sig": false, "md5_digest": "2f3fca8fa3817992567c006051771491", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5577, "upload_time": "2018-05-07T18:56:39", "url": "https://files.pythonhosted.org/packages/b6/d1/821a91bafedbc4100357d8fadf93ba422e7ff06cf9b697b573b73422fefa/buttercms-python-1.1.tar.gz" } ] }