Library to generate Markdown table
Project description
py-markdown-table-generator
Python library to generate Markdown table.
Usage
pip3 install markdown_table_generator
CLI
csv-to-md -s ";" -a c tests/table.csv
# | OS | Creator | Company |
# |:-------:|:-----------------:|:---------:|
# | Ubuntu | Mark Shuttleworth | Canonical |
# | FreeBSD | | |
# | Fedora | | Red Hat |
csv-to-md -s ";" -a r tests/table.csv
# | OS | Creator | Company |
# |--------:|------------------:|----------:|
# | Ubuntu | Mark Shuttleworth | Canonical |
# | FreeBSD | | |
# | Fedora | | Red Hat |
csv-to-md -s ";" -a r tests/table.csv | xclip -selection clipboard # Copy markdown table in clipboard
psql -h 127.0.0.1 -U postgres postgres -c "select * from test" --csv | csv-to-md # Generate markdown table from PostgreSQL query
Library
from markdown_table_generator import generate_markdown, table_from_string_list
# ====================================================
# Generate markdown table from list of list of strings
# ====================================================
rows = [
["OS", "Creator", "Company"],
["Ubuntu", "Mark Shuttleworth", "Canonical"],
["FreeBSD", None, None],
["Fedora", None, "Red Hat"],
]
table = table_from_string_list(rows, Alignment.CENTER)
markdown = generate_markdown(table)
print(markdown)
# | OS | Creator | Company |
# |:-------:|:-----------------:|:---------:|
# | Ubuntu | Mark Shuttleworth | Canonical |
# | FreeBSD | | |
# | Fedora | | Red Hat |
# ====================================================
# Generate markdown table from CSV
# ====================================================
csv = """
OS;Creator;Company
Ubuntu;Mark Shuttleworth;Canonical
FreeBSD;;
Fedora;;Red Hat
"""
table = table_from_csv(csv.splitlines(), ";", Alignment.RIGHT)
markdown = generate_markdown(table)
print(markdown)
# | OS | Creator | Company |
# |--------:|------------------:|----------:|
# | Ubuntu | Mark Shuttleworth | Canonical |
# | FreeBSD | | |
# | Fedora | | Red Hat |
Build
python3 -m venv venv
. ./venv/bin/activate
pip install -r requirements.txt
python3 -m build
Test
python3 -m venv venv
. ./venv/bin/activate
pip install -r requirements.txt
pytest
Contribute
ln -s "$(pwd)/sh/pre-commit.sh" .git/hooks/pre-commit
... and let's code!
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file markdown_table_generator-1.1.0.tar.gz
.
File metadata
- Download URL: markdown_table_generator-1.1.0.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.22.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/18.0.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e85db805fc5db6bc0b31931460de55e28feefcfee59dfd54bfadfee9c5b905f5 |
|
MD5 | 4d8f28fcf3803213da222e4cab888777 |
|
BLAKE2b-256 | 766b38b68061d8590cfc8ea6b296ece9832193beef7224a4292231734d39e2a8 |
File details
Details for the file markdown_table_generator-1.1.0-py3-none-any.whl
.
File metadata
- Download URL: markdown_table_generator-1.1.0-py3-none-any.whl
- Upload date:
- Size: 5.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.22.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/18.0.1 rfc3986/2.0.0 colorama/0.4.3 CPython/3.8.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a14af5c81f5bf0c054c4ddd07cf1692a930dd5db33803a83b5d73f877be37e5 |
|
MD5 | fa07a59d5e0dc829a24b27fe32dda228 |
|
BLAKE2b-256 | 77e377e6e6f763cbca9a2f36410735c025cb76a3cba3b2372a0eeabbf4b72daf |