Skip to main content

An mdformat plugin for rendering tables.

Project description

mdformat-tables

Build Status codecov.io PyPI version

An mdformat plugin for rendering tables.

For example, converting:

a | b | c
:- | -: | :-:
1 | 2 | 3
xxxxxx | yyyyyy | zzzzzz

to:

| a      |      b |   c    |
| :----- | -----: | :----: |
| 1      |      2 |   3    |
| xxxxxx | yyyyyy | zzzzzz |

For further examples, see tests/fixtures.md in the repository.

Development

This package utilises flit as the build engine, and tox for test automation.

To install these development dependencies:

pip install flit tox

To run the tests:

tox

To run the code formatting and style checks:

tox -e py37-pre-commit

or directly

pip install pre-commit
pre-commit run --all

To run the pre-commit hook test:

tox -e py37-hook

Publish to PyPi

Either use flit directly:

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

mdformat_tables-1.0.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

mdformat_tables-1.0.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file mdformat_tables-1.0.0.tar.gz.

File metadata

  • Download URL: mdformat_tables-1.0.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for mdformat_tables-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a57db1ac17c4a125da794ef45539904bb8a9592e80557d525e1f169c96daa2c8
MD5 b87a9f9405d7be94e96992bd8bf93ad7
BLAKE2b-256 64fc995ba209096bdebdeb8893d507c7b32b7e07d9a9f2cdc2ec07529947794b

See more details on using hashes here.

File details

Details for the file mdformat_tables-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mdformat_tables-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94cd86126141b2adc3b04c08d1441eb1272b36c39146bab078249a41c7240a9a
MD5 6a6813d7eb2e02c89f1e981b7a244c1a
BLAKE2b-256 2a37d78e37d14323da3f607cd1af7daf262cb87fe614a245c15ad03bb03a2706

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page