An mdformat plugin for parsing/validating footnotes
Project description
mdformat-footnote
An mdformat plugin for...
Development
This package utilises flit as the build engine, and tox for test automation.
To install these development dependencies:
pip install tox
To run the tests:
tox
and with test coverage:
tox -e py39-cov
The easiest way to write tests, is to edit tests/fixtures.md
To run the code formatting and style checks:
tox -e py39-pre-commit
or directly
pip install pre-commit
pre-commit run --all
To run the pre-commit hook test:
tox -e py39-hook
Publish to PyPi
Either use flit directly:
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
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mdformat_footnote-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcd5f21851c1a0f98b935819fc9150bcdb43324f3ae02c95fdce4c7277d713c7 |
|
MD5 | 9f1d2bbde8f0389c0d52f96315dcdedd |
|
BLAKE2b-256 | b512da42142f9c453df10c0a30c9eafedcb7b32ed4fe6a6919385ad7b5d3a4cf |