{ "info": { "author": "Anthony Sottile", "author_email": "asottile@umich.edu", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy" ], "description": "[![Build Status](https://travis-ci.org/asottile/blacken-docs.svg?branch=master)](https://travis-ci.org/asottile/blacken-docs)\n[![Coverage Status](https://coveralls.io/repos/github/asottile/blacken-docs/badge.svg?branch=master)](https://coveralls.io/github/asottile/blacken-docs?branch=master)\n\nblacken-docs\n============\n\nRun `black` on python code blocks in documentation files.\n\n## install\n\n`pip install blacken-docs`\n\n## usage\n\n`blacken-docs` provides a single executable (`blacken-docs`) which will modify\n`.rst` / `.md` files in place.\n\nIt currently supports the following [`black`](https://github.com/ambv/black)\noptions:\n\n- `-l` / `--line-length`\n- `-t` / `--target-version`\n- `-S` / `--skip-string-normalization`\n\nFollowing additional parameters can be used:\n\n - `-E` / `--skip-errors`\n\n`blacken-docs` will format code in the following block types:\n\n(markdown)\n```markdown\n ```python\n def hello():\n print(\"hello world\")\n ```\n```\n\n(rst)\n```rst\n .. code-block:: python\n\n def hello():\n print(\"hello world\")\n```\n\n## usage with pre-commit\n\nSee [pre-commit](https://pre-commit.com) for instructions\n\nSample `.pre-commit-config.yaml`:\n\n\n```yaml\n- repo: https://github.com/asottile/blacken-docs\n rev: v1.3.0\n hooks:\n - id: blacken-docs\n additional_dependencies: [black==...]\n```\n\nSince `black` is currently a moving target, it is suggested to pin `black`\nto a specific version using `additional_dependencies`.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/asottile/blacken-docs", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "blacken-docs", "package_url": "https://pypi.org/project/blacken-docs/", "platform": "", "project_url": "https://pypi.org/project/blacken-docs/", "project_urls": { "Homepage": "https://github.com/asottile/blacken-docs" }, "release_url": "https://pypi.org/project/blacken-docs/1.3.0/", "requires_dist": [ "black (>=19.3b0)" ], "requires_python": ">=3.6", "summary": "Run `black` on python code blocks in documentation files", "version": "1.3.0" }, "last_serial": 5626688, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "c48af09c5f55aee4d5bad01a328b4401", "sha256": "fada22d2249fb397db21fec954b77babb1cd7b7db3218206231bd845fcacf60b" }, "downloads": -1, "filename": "blacken_docs-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c48af09c5f55aee4d5bad01a328b4401", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 2885, "upload_time": "2018-06-03T03:08:07", "url": "https://files.pythonhosted.org/packages/cf/eb/5d285d7025bff85446170a4bf4f1902e0ee60db1065b7ca45db45b652ac8/blacken_docs-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a589a8f5d9ffc79dd15b6455e26b79d1", "sha256": "ea35d9e5fc1cc09e59b441b951c69847cb233edb82d487a18b6ed12b0fbf8d5e" }, "downloads": -1, "filename": "blacken_docs-0.1.0.tar.gz", "has_sig": false, "md5_digest": "a589a8f5d9ffc79dd15b6455e26b79d1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2700, "upload_time": "2018-06-03T03:08:09", "url": "https://files.pythonhosted.org/packages/49/c2/779a65b924fcb168c57b63808beba1fdae8990ca45e5d4ffa17820b8bacc/blacken_docs-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "ed2d6725f1a7b6748a3fcf341c13e7c5", "sha256": "bafca7e9f0871ed7178f7f9f1228139a4fa47f48e610fce5861b0276f064f730" }, "downloads": -1, "filename": "blacken_docs-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ed2d6725f1a7b6748a3fcf341c13e7c5", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 2900, "upload_time": "2018-06-03T15:04:01", "url": "https://files.pythonhosted.org/packages/92/2c/4842507fb54a7b87aabc78db8af07b72b0041b65d1cb45f0d9548672ee1d/blacken_docs-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d0812d74d01fe49c2861f9d3cc746cf", "sha256": "7a1e9282aff99aaa00ac67e60547253f5b0963026ca53037b1be6afde741b0c1" }, "downloads": -1, "filename": "blacken_docs-0.1.1.tar.gz", "has_sig": false, "md5_digest": "3d0812d74d01fe49c2861f9d3cc746cf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2788, "upload_time": "2018-06-03T15:04:02", "url": "https://files.pythonhosted.org/packages/91/48/8fc3baa38d4a81b94cded03be381a42c1767cf5904014080c13bfe25884a/blacken_docs-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "e240171d8c1bceb4a2737110b4b5337f", "sha256": "59772aff4b45983c60178215891dc59b34e2ec9067613c605aa6806e85930c90" }, "downloads": -1, "filename": "blacken_docs-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e240171d8c1bceb4a2737110b4b5337f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 2888, "upload_time": "2018-06-06T01:40:37", "url": "https://files.pythonhosted.org/packages/c4/98/433a06e0a156efb9c148d0277194706a44371803a2a41d4d287d6322ddbd/blacken_docs-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6bb9ad31d825496d97d49824d655d2a2", "sha256": "c4597e148ce9091792c7a549119a820f20bdc769b3b62c0f39c0d014e7b42ecd" }, "downloads": -1, "filename": "blacken_docs-0.2.0.tar.gz", "has_sig": false, "md5_digest": "6bb9ad31d825496d97d49824d655d2a2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2788, "upload_time": "2018-06-06T01:40:39", "url": "https://files.pythonhosted.org/packages/24/35/d6e371f65444934d2e91b34f7ea207166a602a1f4b41294814002a985d97/blacken_docs-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "af5d5f57f37749c1853d48f0e89304aa", "sha256": "6244b7f1c7dc85747981524997be0cb569202407f665bd4ae8ae5a7fe4693a37" }, "downloads": -1, "filename": "blacken_docs-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "af5d5f57f37749c1853d48f0e89304aa", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 2980, "upload_time": "2018-09-17T20:14:03", "url": "https://files.pythonhosted.org/packages/79/91/7c9d898029516f7b1402eb65d242a921287001c89f8fa2279bd65816f019/blacken_docs-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "be7195740262eebb30f62b98bb6879b8", "sha256": "9426adbbdc52eab030e407b4adf85be4703176528c203924dd30d7f97ffc6ec4" }, "downloads": -1, "filename": "blacken_docs-0.3.0.tar.gz", "has_sig": false, "md5_digest": "be7195740262eebb30f62b98bb6879b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2930, "upload_time": "2018-09-17T20:14:04", "url": "https://files.pythonhosted.org/packages/d2/b7/4d9d684c0b5409d3e3de79910215b23182956ebe2c77197009ce7655a790/blacken_docs-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "e24e1684d6e70d49d5ef439b8356931e", "sha256": "9c0527f910513f9c0563b3f6df8b9731f7047a1fb6185a9bd6590b520946f73c" }, "downloads": -1, "filename": "blacken_docs-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e24e1684d6e70d49d5ef439b8356931e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4407, "upload_time": "2019-02-28T06:31:15", "url": "https://files.pythonhosted.org/packages/05/62/062efde5ecc15af386299134aaf380845e65ad43e5335b0413a7d1c64892/blacken_docs-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b70a17c8a8df7bef39097ec3f4781aa1", "sha256": "c31fe4a1321cab74686d6af3372f2b34f180f70b9989676e17c5f4ccc88ab631" }, "downloads": -1, "filename": "blacken_docs-0.4.0.tar.gz", "has_sig": false, "md5_digest": "b70a17c8a8df7bef39097ec3f4781aa1", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 3907, "upload_time": "2019-02-28T06:31:16", "url": "https://files.pythonhosted.org/packages/eb/20/09903eb70ca3738a3d7b7e7f66c6325c6886ea7ef6d2a9d025817d99b001/blacken_docs-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "08653cb9af2c8a596d99868bee828720", "sha256": "483ac178bb706fb77c4a383cd3b5f5eaf0d88f46b57baeaa9a05bf3f79d4d2c3" }, "downloads": -1, "filename": "blacken_docs-0.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "08653cb9af2c8a596d99868bee828720", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4444, "upload_time": "2019-03-15T04:10:28", "url": "https://files.pythonhosted.org/packages/f6/5b/35049ea1f8e9e68a2b42a5e083b0faf21be80fcab684c2bcf476bba05ed3/blacken_docs-0.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5de2713b792854ce2e38e5cbd51107b9", "sha256": "7b7b1b895287acbcb86451af9391f92327b3ecb7d513783cf99e8990dd0b4938" }, "downloads": -1, "filename": "blacken_docs-0.5.0.tar.gz", "has_sig": false, "md5_digest": "5de2713b792854ce2e38e5cbd51107b9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 3940, "upload_time": "2019-03-15T04:10:29", "url": "https://files.pythonhosted.org/packages/14/cc/bb0fef3d13fd2873db1989af82c5a94daf88da5a140eae3a07e0d0595df6/blacken_docs-0.5.0.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "13e000f5a47b19ec910fdc62d1e5f8a9", "sha256": "453b445ae60300a9bb92e0b372936ddc68d9c054ab3d3535d57ab10a56ef9b7b" }, "downloads": -1, "filename": "blacken_docs-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "13e000f5a47b19ec910fdc62d1e5f8a9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4436, "upload_time": "2019-05-26T15:32:49", "url": "https://files.pythonhosted.org/packages/69/06/5f8e6eeb69268986051f540358fd17a029f331667dbc6b32447cc4d5e962/blacken_docs-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8d244f8be0f516d735fe7b41ae78afc8", "sha256": "398ba3d28556e569da406379f785e88e351349a139528eab74ecf2f4ba751a2e" }, "downloads": -1, "filename": "blacken_docs-1.0.0.tar.gz", "has_sig": false, "md5_digest": "8d244f8be0f516d735fe7b41ae78afc8", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 3967, "upload_time": "2019-05-26T15:32:50", "url": "https://files.pythonhosted.org/packages/88/dd/e10c969ffdf22810f9fd30a414f5d398ae6e4a0225ee7114ef54ce705b8f/blacken_docs-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "5c0f18906cb6c84fb43485017b44bb30", "sha256": "12f5483c8ec56e7c28953c3b7f9b8b840e3cae0f8ce5692fd0fe31d7c334dae0" }, "downloads": -1, "filename": "blacken_docs-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5c0f18906cb6c84fb43485017b44bb30", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4439, "upload_time": "2019-06-23T17:36:23", "url": "https://files.pythonhosted.org/packages/c5/84/229f165070d855224b7873f376b9c2ab32136c30b7d478d5cd3a9533ba42/blacken_docs-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e1d0c0e8ebefedb40650cc103cd5eb4c", "sha256": "5d0db1a256098fde879c57a675ff7c76c3c54c2fae9cdd949ed6fb2fcc2d51e7" }, "downloads": -1, "filename": "blacken_docs-1.1.0.tar.gz", "has_sig": false, "md5_digest": "e1d0c0e8ebefedb40650cc103cd5eb4c", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4021, "upload_time": "2019-06-23T17:36:24", "url": "https://files.pythonhosted.org/packages/1a/4e/4751825612f8a4a2e1a4f5bee5d843348c982c7352ee8901688d83bece81/blacken_docs-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "b55be277e5d5a111aad0a79a4c86dd5e", "sha256": "ffc16e490c5a6d173786d780a4860756cf244e8f8b518861b0d385cddc2c1d71" }, "downloads": -1, "filename": "blacken_docs-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b55be277e5d5a111aad0a79a4c86dd5e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4442, "upload_time": "2019-07-07T19:42:45", "url": "https://files.pythonhosted.org/packages/21/43/78cc1117d258c4339a231298780d88e0ec81cc6856188fd02d17b81f5ca2/blacken_docs-1.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a5c9ecf34e82fe067a3f478a1d72e575", "sha256": "d826f06830736c7f5085cb924d800c7fdf3087f8df05db3f635592935c824ddf" }, "downloads": -1, "filename": "blacken_docs-1.2.0.tar.gz", "has_sig": false, "md5_digest": "a5c9ecf34e82fe067a3f478a1d72e575", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4028, "upload_time": "2019-07-07T19:42:47", "url": "https://files.pythonhosted.org/packages/e5/34/473043f33b0264b9f91b2473bfa1dca66d132976c5e7e5ec9423a967a9f9/blacken_docs-1.2.0.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "db500fb1c85e39125948755f2de45514", "sha256": "be191a74251939296752b8ac9ad5bce85944262277766a1970f59a1a1f2ca383" }, "downloads": -1, "filename": "blacken_docs-1.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "db500fb1c85e39125948755f2de45514", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4489, "upload_time": "2019-08-02T22:53:32", "url": "https://files.pythonhosted.org/packages/5a/f3/0232b9750ed1878dd03a171c9a45dab8a1c1d3ef5f385529392bdc3ef3be/blacken_docs-1.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae68851588670ff6e64dd14318103924", "sha256": "668583c5d072dc93e1e57374fc0b34aad42c0fbac7a814d609b8e38aaf73bbcb" }, "downloads": -1, "filename": "blacken_docs-1.3.0.tar.gz", "has_sig": false, "md5_digest": "ae68851588670ff6e64dd14318103924", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4017, "upload_time": "2019-08-02T22:53:33", "url": "https://files.pythonhosted.org/packages/01/3e/e2d8f272122a189f7c8113643699512d8a1fd4d289de3ea68ba6e19389f0/blacken_docs-1.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "db500fb1c85e39125948755f2de45514", "sha256": "be191a74251939296752b8ac9ad5bce85944262277766a1970f59a1a1f2ca383" }, "downloads": -1, "filename": "blacken_docs-1.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "db500fb1c85e39125948755f2de45514", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 4489, "upload_time": "2019-08-02T22:53:32", "url": "https://files.pythonhosted.org/packages/5a/f3/0232b9750ed1878dd03a171c9a45dab8a1c1d3ef5f385529392bdc3ef3be/blacken_docs-1.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae68851588670ff6e64dd14318103924", "sha256": "668583c5d072dc93e1e57374fc0b34aad42c0fbac7a814d609b8e38aaf73bbcb" }, "downloads": -1, "filename": "blacken_docs-1.3.0.tar.gz", "has_sig": false, "md5_digest": "ae68851588670ff6e64dd14318103924", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4017, "upload_time": "2019-08-02T22:53:33", "url": "https://files.pythonhosted.org/packages/01/3e/e2d8f272122a189f7c8113643699512d8a1fd4d289de3ea68ba6e19389f0/blacken_docs-1.3.0.tar.gz" } ] }