Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lzakharov/csv2md
Command line tool for converting CSV files into Markdown tables.
https://github.com/lzakharov/csv2md
cli csv csv2md markdown python
Last synced: 17 days ago
JSON representation
Command line tool for converting CSV files into Markdown tables.
- Host: GitHub
- URL: https://github.com/lzakharov/csv2md
- Owner: lzakharov
- License: mit
- Created: 2018-02-03T21:42:22.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T18:13:06.000Z (about 1 month ago)
- Last Synced: 2024-11-05T18:25:42.797Z (about 1 month ago)
- Topics: cli, csv, csv2md, markdown, python
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 104
- Watchers: 4
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - lzakharov/csv2md - Command line tool for converting CSV files into Markdown tables. (Python)
README
# csv2md [](https://codecov.io/gh/lzakharov/csv2md)
Command line tool for converting CSV files into Markdown tables.
## Installation
csv2md can be installed from source:
```commandline
# type in project directory
python setup.py install
```
Or with `pip` from PyPI:
```commandline
pip install csv2md
```
### Requirements
- Python 3.6 or later. See https://www.python.org/getit/
## Usage
Generate Markdown table from CSV file:
```commandline
csv2md table.csv
```
Generate Markdown table from TSV file:
```commandline
csv2md -d $'\t' table.tsv
```
Generate Markdown tables from list of CSV files:
```commandline
csv2md table1.csv table2.csv table3.csv
```
Generate Markdown table from standard input:
```commandline
csv2md
```
You can also use it right inside your code, for example:
```python
from csv2md.table import Table
with open("input.csv") as f:
table = Table.parse_csv(f)
print(table.markdown())
```
### Examples
Input file: `simple.csv`
```
year,make,model,description,price
1997,Ford,E350,"ac, abs, moon",3000.00
1999,Chevy,"Venture «Extended Edition»","",4900.00
1996,Jeep,Grand Cherokee,"MUST SELL! air, moon roof, loaded",4799.00
```
Output: `csv2md simple.csv`
```
| year | make | model | description | price |
| ---- | ----- | -------------------------- | --------------------------------- | ------- |
| 1997 | Ford | E350 | ac, abs, moon | 3000.00 |
| 1999 | Chevy | Venture «Extended Edition» | | 4900.00 |
| 1996 | Jeep | Grand Cherokee | MUST SELL! air, moon roof, loaded | 4799.00 |
```
Markdown table:
| year | make | model | description | price |
| ---- | ----- | -------------------------- | --------------------------------- | ------- |
| 1997 | Ford | E350 | ac, abs, moon | 3000.00 |
| 1999 | Chevy | Venture «Extended Edition» | | 4900.00 |
| 1996 | Jeep | Grand Cherokee | MUST SELL! air, moon roof, loaded | 4799.00 |
You can also specify delimiter, quotation characters and alignment (see [Help](https://github.com/lzakharov/csv2md#help)).
## Help
To view help run `csv2md -h`:
```commandline
usage: csv2md [-h] [-d DELIMITER] [-q QUOTECHAR] [-C COLUMNS]
[-c [CENTER_ALIGNED_COLUMNS ...]]
[-r [RIGHT_ALIGNED_COLUMNS ...]] [-H]
[CSV_FILE ...]
Parse CSV files into Markdown tables.
positional arguments:
CSV_FILE One or more CSV files to parse
options:
-h, --help show this help message and exit
-d DELIMITER, --delimiter DELIMITER
delimiter character. Default is ','
-q QUOTECHAR, --quotechar QUOTECHAR
quotation character. Default is '"'
-C COLUMNS, --columns COLUMNS
comma-separated list of column indices or ranges (from
zero) to be processed, e.g. "0,3-5,7". Indices out of
range will be ignored
-c [CENTER_ALIGNED_COLUMNS ...], --center-aligned-columns [CENTER_ALIGNED_COLUMNS ...]
column numbers with center alignment (from zero)
-r [RIGHT_ALIGNED_COLUMNS ...], --right-aligned-columns [RIGHT_ALIGNED_COLUMNS ...]
column numbers with right alignment (from zero)
-H, --no-header-row specify that the input CSV file has no header row.
Will create default headers in Excel format
(a,b,c,...)
```
## Running Tests
To run the tests, enter:
```commandline
nosetest
```
## Issue tracker
Please report any bugs and enhancement ideas using the csv2md issue tracker:
https://github.com/lzakharov/csv2md/issues
Feel free to also ask questions on the tracker.