# mdformat-pyproject
[![Build Status][ci-badge]][ci-link] [![codecov.io][cov-badge]][cov-link]
[![PyPI version][pypi-badge]][pypi-link]
An [mdformat] plugin to read configuration from `pyproject.toml`.
## Install
Install with:
```bash
pip install mdformat-pyproject
```
## Usage
After installing this plugin, the [mdformat configuration][mdformat-configuration] can be added in
a new `[tool.mdformat]` section inside the `pyproject.toml` file.
```toml
[tool.mdformat]
wrap = "keep" # possible values: {"keep", "no", INTEGER}
number = false # possible values: {false, true}
end_of_line = "lf" # possible values: {"lf", "crlf", "keep"}
```
## Usage as a [pre-commit] hook
Add the following to your `.pre-commit-config.yaml`:
```yaml
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.13 # Use the ref you want to point at
hooks:
- id: mdformat
additional_dependencies:
- mdformat-pyproject
```
[ci-badge]: https://github.com/csala/mdformat-pyproject/workflows/CI/badge.svg?branch=master
[ci-link]: https://github.com/csala/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
[cov-badge]: https://codecov.io/gh/csala/mdformat-pyproject/branch/master/graph/badge.svg
[cov-link]: https://codecov.io/gh/csala/mdformat-pyproject
[mdformat]: https://github.com/executablebooks/mdformat
[mdformat-configuration]: https://mdformat.readthedocs.io/en/stable/users/configuration_file.html
[pre-commit]: https://pre-commit.com
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-pyproject.svg
[pypi-link]: https://pypi.org/project/mdformat-pyproject
Raw data
{
"_id": null,
"home_page": null,
"name": "mdformat_pyproject",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mdformat, markdown, markdown-it",
"author": null,
"author_email": "Carles Sala <csala@csail.mit.com>",
"download_url": "https://files.pythonhosted.org/packages/5f/b0/6c7342afcb5518891f3c908f9e9f73fc399b727fe5b8133b31c8d468eae6/mdformat_pyproject-0.0.2.tar.gz",
"platform": null,
"description": "# mdformat-pyproject\n\n[![Build Status][ci-badge]][ci-link] [![codecov.io][cov-badge]][cov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\nAn [mdformat] plugin to read configuration from `pyproject.toml`.\n\n## Install\n\nInstall with:\n\n```bash\npip install mdformat-pyproject\n```\n\n## Usage\n\nAfter installing this plugin, the [mdformat configuration][mdformat-configuration] can be added in\na new `[tool.mdformat]` section inside the `pyproject.toml` file.\n\n```toml\n[tool.mdformat]\nwrap = \"keep\" # possible values: {\"keep\", \"no\", INTEGER}\nnumber = false # possible values: {false, true}\nend_of_line = \"lf\" # possible values: {\"lf\", \"crlf\", \"keep\"}\n```\n\n## Usage as a [pre-commit] hook\n\nAdd the following to your `.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/executablebooks/mdformat\n rev: 0.7.13 # Use the ref you want to point at\n hooks:\n - id: mdformat\n additional_dependencies:\n - mdformat-pyproject\n```\n\n[ci-badge]: https://github.com/csala/mdformat-pyproject/workflows/CI/badge.svg?branch=master\n[ci-link]: https://github.com/csala/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush\n[cov-badge]: https://codecov.io/gh/csala/mdformat-pyproject/branch/master/graph/badge.svg\n[cov-link]: https://codecov.io/gh/csala/mdformat-pyproject\n[mdformat]: https://github.com/executablebooks/mdformat\n[mdformat-configuration]: https://mdformat.readthedocs.io/en/stable/users/configuration_file.html\n[pre-commit]: https://pre-commit.com\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-pyproject.svg\n[pypi-link]: https://pypi.org/project/mdformat-pyproject\n",
"bugtrack_url": null,
"license": null,
"summary": "An mdformat plugin for...",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/csala/mdformat-pyproject"
},
"split_keywords": [
"mdformat",
" markdown",
" markdown-it"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bbd70598e8de54d439ee7deda6bcba7816b36aaf28c26542ff9a0510cc29c079",
"md5": "d46a6c8f7fe898396c723813024fabd5",
"sha256": "e0791a335e53264d5589be353c519e230ac555b64fa076005bc64ca037717710"
},
"downloads": -1,
"filename": "mdformat_pyproject-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d46a6c8f7fe898396c723813024fabd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4761,
"upload_time": "2024-11-20T19:39:11",
"upload_time_iso_8601": "2024-11-20T19:39:11.879902Z",
"url": "https://files.pythonhosted.org/packages/bb/d7/0598e8de54d439ee7deda6bcba7816b36aaf28c26542ff9a0510cc29c079/mdformat_pyproject-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5fb06c7342afcb5518891f3c908f9e9f73fc399b727fe5b8133b31c8d468eae6",
"md5": "fa5f2981afe0d639bb4150183ab26346",
"sha256": "1638c4be0d239f49eea72089aafd06dc4ec603068ccc4868f91f0958b15b82c8"
},
"downloads": -1,
"filename": "mdformat_pyproject-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fa5f2981afe0d639bb4150183ab26346",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5550,
"upload_time": "2024-11-20T19:39:13",
"upload_time_iso_8601": "2024-11-20T19:39:13.301022Z",
"url": "https://files.pythonhosted.org/packages/5f/b0/6c7342afcb5518891f3c908f9e9f73fc399b727fe5b8133b31c8d468eae6/mdformat_pyproject-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 19:39:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csala",
"github_project": "mdformat-pyproject",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mdformat_pyproject"
}
JSON
