# blacken-docs-jb
Extension of [blacken-docs](https://github.com/asottile/blacken-docs) which also supports the [executable code blocks](https://jupyterbook.org/en/stable/reference/cheatsheet.html#executable-code) from [JupyterBook](https://jupyterbook.org) e.g
````
```{code-cell} python
x = 1 + 2
```
````
## Install
```bash
pip install blacken-docs-jb
```
## Usage with pre-commit
See [pre-commit](https://pre-commit.com) for instructions
Sample `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/finsberg/blacken-docs-jb
rev: v0.6.2
hooks:
- id: blacken-docs-jb
additional_dependencies: [black==22.3.0]
exclude: slides
```
## License
This project is licensed under [MIT](LICENSE). The license file from blacken-docs is found in [LICENSE_blacken_docs](LICENSE_blacken_docs).
Raw data
{
"_id": null,
"home_page": "https://github.com/finsberg/blacken-docs-jb",
"name": "blacken-docs-jb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Henrik Finsberg",
"author_email": "henriknf@simula.no",
"download_url": "https://files.pythonhosted.org/packages/4c/a6/6a074245131bd7d47e11cd4141c83adf343dee2356869502ecacf1525078/blacken_docs_jb-0.6.2.tar.gz",
"platform": null,
"description": "# blacken-docs-jb\n\nExtension of [blacken-docs](https://github.com/asottile/blacken-docs) which also supports the [executable code blocks](https://jupyterbook.org/en/stable/reference/cheatsheet.html#executable-code) from [JupyterBook](https://jupyterbook.org) e.g\n\n````\n```{code-cell} python\nx = 1 + 2\n```\n````\n\n## Install\n\n```bash\npip install blacken-docs-jb\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```yaml\n- repo: https://github.com/finsberg/blacken-docs-jb\n rev: v0.6.2\n hooks:\n - id: blacken-docs-jb\n additional_dependencies: [black==22.3.0]\n exclude: slides\n```\n\n## License\nThis project is licensed under [MIT](LICENSE). The license file from blacken-docs is found in [LICENSE_blacken_docs](LICENSE_blacken_docs).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Run `black` on python code blocks in documentation files (also for jupyterbook)",
"version": "0.6.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0178b0c6a97aec17a961ec43613429aa7ff66f8383f47733aca2aab2e413dfcf",
"md5": "3af88ebd850a8868662b6298e4b05f38",
"sha256": "00a1b709b9d95c33ac6592072a71e4da26ca5dde94a6845e7f465cee9108d747"
},
"downloads": -1,
"filename": "blacken_docs_jb-0.6.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3af88ebd850a8868662b6298e4b05f38",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 4604,
"upload_time": "2023-01-09T08:39:02",
"upload_time_iso_8601": "2023-01-09T08:39:02.701054Z",
"url": "https://files.pythonhosted.org/packages/01/78/b0c6a97aec17a961ec43613429aa7ff66f8383f47733aca2aab2e413dfcf/blacken_docs_jb-0.6.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ca66a074245131bd7d47e11cd4141c83adf343dee2356869502ecacf1525078",
"md5": "3e9ba61a3b323af3599699ed9d1884b1",
"sha256": "5f565cd057a5a9a74e9474804db4830717ef07d911abd3d437216d9a78351668"
},
"downloads": -1,
"filename": "blacken_docs_jb-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "3e9ba61a3b323af3599699ed9d1884b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4226,
"upload_time": "2023-01-09T08:39:03",
"upload_time_iso_8601": "2023-01-09T08:39:03.887011Z",
"url": "https://files.pythonhosted.org/packages/4c/a6/6a074245131bd7d47e11cd4141c83adf343dee2356869502ecacf1525078/blacken_docs_jb-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-09 08:39:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "finsberg",
"github_project": "blacken-docs-jb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "blacken-docs-jb"
}
JSON
