# mdformat-footnote
[![Build Status][ci-badge]][ci-link]
[![codecov.io][cov-badge]][cov-link]
[![PyPI version][pypi-badge]][pypi-link]
Footnote format addition for [mdformat](https://github.com/executablebooks/mdformat).
## 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 py39-cov
```
The easiest way to write tests, is to edit tests/fixtures.md
To run the code formatting and style checks:
```bash
tox -e py39-pre-commit
```
or directly
```bash
pip install pre-commit
pre-commit run --all
```
To run the pre-commit hook test:
```bash
tox -e py39-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/gaige/mdformat-footnote/workflows/CI/badge.svg?branch=master
[ci-link]: https://github.com/gaige/mdformat-footnote/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
[cov-badge]: https://codecov.io/gh/gaige/mdformat-footnote/branch/master/graph/badge.svg
[cov-link]: https://codecov.io/gh/gaige/mdformat-footnote
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-footnote.svg
[pypi-link]: https://pypi.org/project/mdformat-footnote
Raw data
{
"_id": null,
"home_page": "https://github.com/gaige/mdformat-footnote",
"name": "mdformat_footnote",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "mdformat,markdown,markdown-it",
"author": "Gaige B. Paulsen",
"author_email": "gaige@cluetrust.com",
"download_url": "https://files.pythonhosted.org/packages/f6/90/7f4b2729af8d691a57518e8202e90c3a638714437b5e753662982f744cb5/mdformat_footnote-0.1.1.tar.gz",
"platform": "",
"description": "# mdformat-footnote\n\n[![Build Status][ci-badge]][ci-link]\n[![codecov.io][cov-badge]][cov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\nFootnote format addition for [mdformat](https://github.com/executablebooks/mdformat).\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 py39-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 py39-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 py39-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/gaige/mdformat-footnote/workflows/CI/badge.svg?branch=master\n[ci-link]: https://github.com/gaige/mdformat-footnote/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush\n[cov-badge]: https://codecov.io/gh/gaige/mdformat-footnote/branch/master/graph/badge.svg\n[cov-link]: https://codecov.io/gh/gaige/mdformat-footnote\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-footnote.svg\n[pypi-link]: https://pypi.org/project/mdformat-footnote\n",
"bugtrack_url": null,
"license": "",
"summary": "An mdformat plugin for parsing/validating footnotes",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/gaige/mdformat-footnote"
},
"split_keywords": [
"mdformat",
"markdown",
"markdown-it"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93aa4736dc47867c60236a9992f2f779e85e5331e65e648434d6362c3ed2dae0",
"md5": "65ff87b78fa8d5664cc73a78379b5c9d",
"sha256": "30063aaa0f74c36257c2e80fa0cf00d7c71a5277f27e98109e8765ae8678a95b"
},
"downloads": -1,
"filename": "mdformat_footnote-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65ff87b78fa8d5664cc73a78379b5c9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4120,
"upload_time": "2022-02-16T09:17:53",
"upload_time_iso_8601": "2022-02-16T09:17:53.630378Z",
"url": "https://files.pythonhosted.org/packages/93/aa/4736dc47867c60236a9992f2f779e85e5331e65e648434d6362c3ed2dae0/mdformat_footnote-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f6907f4b2729af8d691a57518e8202e90c3a638714437b5e753662982f744cb5",
"md5": "866a1a593eb14ec0ebec45dcea181755",
"sha256": "3b85c4c84119f15f0b651df89c99a4f6f119fc46dca6b33f7edf4f09655d1126"
},
"downloads": -1,
"filename": "mdformat_footnote-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "866a1a593eb14ec0ebec45dcea181755",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5224,
"upload_time": "2022-02-16T09:17:58",
"upload_time_iso_8601": "2022-02-16T09:17:58.647690Z",
"url": "https://files.pythonhosted.org/packages/f6/90/7f4b2729af8d691a57518e8202e90c3a638714437b5e753662982f744cb5/mdformat_footnote-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-02-16 09:17:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gaige",
"github_project": "mdformat-footnote",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "mdformat_footnote"
}
JSON
