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.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 197c9b1a7c0e28fe1463b73a17dcb59a7829c82d633884125693c5098e30690b |
|
MD5 | 7d7a24937cecad850ac52817fd89267c |
|
BLAKE2b-256 | c04b44f5755d9c89dd561f26773b89bdada7e4ee39a6b95bcc60bf68fec4aeab |