# mdformat-deflist
[![Build Status][ci-badge]][ci-link]
[![codecov.io][cov-badge]][cov-link]
[![PyPI version][pypi-badge]][pypi-link]
An [mdformat](https://github.com/executablebooks/mdformat) plugin for [markdown-it-deflist](https://github.com/markdown-it/markdown-it-deflist).
## Development
This package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
To install these development dependencies:
```bash
pip install tox
```
To run the tests:
```bash
tox
```
and with test coverage:
```bash
tox -e py37-cov
```
The easiest way to write tests, is to edit tests/fixtures.md
To run the code formatting and style checks:
```bash
tox -e py37-pre-commit
```
or directly
```bash
pip install pre-commit
pre-commit run --all
```
To run the pre-commit hook test:
```bash
tox -e py37-hook
```
## Publish to PyPi
Either use flit directly:
```bash
pip install flit
flit publish
```
or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.
Note, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.
[ci-badge]: https://github.com/executablebooks/mdformat-deflist/workflows/CI/badge.svg?branch=master
[ci-link]: https://github.com/executablebooks/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-deflist/branch/master/graph/badge.svg
[cov-link]: https://codecov.io/gh/executablebooks/mdformat-deflist
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-deflist.svg
[pypi-link]: https://pypi.org/project/mdformat-deflist
Raw data
{
"_id": null,
"home_page": "https://github.com/executablebooks/mdformat-deflist",
"name": "mdformat_deflist",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mdformat, markdown, markdown-it",
"author": "Chris Sewell",
"author_email": "executablebooks@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a9/69/7c1f31529e81ca6d8287a4685cb1d8c894bca5f0149f272b15ce880a4d6f/mdformat_deflist-0.1.3.tar.gz",
"platform": null,
"description": "# mdformat-deflist\n\n[![Build Status][ci-badge]][ci-link]\n[![codecov.io][cov-badge]][cov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\nAn [mdformat](https://github.com/executablebooks/mdformat) plugin for [markdown-it-deflist](https://github.com/markdown-it/markdown-it-deflist).\n\n## Development\n\nThis package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.\n\nTo install these development dependencies:\n\n```bash\npip install tox\n```\n\nTo run the tests:\n\n```bash\ntox\n```\n\nand with test coverage:\n\n```bash\ntox -e py37-cov\n```\n\nThe easiest way to write tests, is to edit tests/fixtures.md\n\nTo run the code formatting and style checks:\n\n```bash\ntox -e py37-pre-commit\n```\n\nor directly\n\n```bash\npip install pre-commit\npre-commit run --all\n```\n\nTo run the pre-commit hook test:\n\n```bash\ntox -e py37-hook\n```\n\n## Publish to PyPi\n\nEither use flit directly:\n\n```bash\npip install flit\nflit publish\n```\n\nor trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. `v0.0.1`.\n\nNote, this requires generating an API key on PyPi and adding it to the repository `Settings/Secrets`, under the name `PYPI_KEY`.\n\n[ci-badge]: https://github.com/executablebooks/mdformat-deflist/workflows/CI/badge.svg?branch=master\n[ci-link]: https://github.com/executablebooks/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush\n[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-deflist/branch/master/graph/badge.svg\n[cov-link]: https://codecov.io/gh/executablebooks/mdformat-deflist\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-deflist.svg\n[pypi-link]: https://pypi.org/project/mdformat-deflist\n",
"bugtrack_url": null,
"license": null,
"summary": "An mdformat plugin for markdown-it-deflist.",
"version": "0.1.3",
"project_urls": {
"Homepage": "https://github.com/executablebooks/mdformat-deflist"
},
"split_keywords": [
"mdformat",
" markdown",
" markdown-it"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "011dded49a526c4965bdd3a3d69075a654b3a560f0350dccc60583c0d8cad813",
"md5": "8e3d53b29f4ffb379681d6a9a34f9efb",
"sha256": "03a69b10e7359233eb1e40551cff890af669c340f2a606477d86e0315364944e"
},
"downloads": -1,
"filename": "mdformat_deflist-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e3d53b29f4ffb379681d6a9a34f9efb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4300,
"upload_time": "2024-12-16T00:53:40",
"upload_time_iso_8601": "2024-12-16T00:53:40.887890Z",
"url": "https://files.pythonhosted.org/packages/01/1d/ded49a526c4965bdd3a3d69075a654b3a560f0350dccc60583c0d8cad813/mdformat_deflist-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a9697c1f31529e81ca6d8287a4685cb1d8c894bca5f0149f272b15ce880a4d6f",
"md5": "1aafdf52966d3b913bb9f68b8b4e5864",
"sha256": "b25091ce1705a37c0cc87ddb1c78a3e7eb43d50adcdb5ad4763411f743ae6f7e"
},
"downloads": -1,
"filename": "mdformat_deflist-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "1aafdf52966d3b913bb9f68b8b4e5864",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5315,
"upload_time": "2024-12-16T00:53:43",
"upload_time_iso_8601": "2024-12-16T00:53:43.413105Z",
"url": "https://files.pythonhosted.org/packages/a9/69/7c1f31529e81ca6d8287a4685cb1d8c894bca5f0149f272b15ce880a4d6f/mdformat_deflist-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 00:53:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "executablebooks",
"github_project": "mdformat-deflist",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mdformat_deflist"
}
JSON
