Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mzjp2/mdtable
Convert CSV files into Markdown formatted tables
https://github.com/mzjp2/mdtable
cli-app csv-converter markdown
Last synced: about 1 month ago
JSON representation
Convert CSV files into Markdown formatted tables
- Host: GitHub
- URL: https://github.com/mzjp2/mdtable
- Owner: mzjp2
- License: mit
- Created: 2019-06-22T17:49:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-20T18:17:12.000Z (over 3 years ago)
- Last Synced: 2024-11-08T14:06:55.446Z (about 2 months ago)
- Topics: cli-app, csv-converter, markdown
- Language: Python
- Size: 18.6 KB
- Stars: 15
- Watchers: 1
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :clipboard: mdtable
[](https://github.com/ambv/black)
[](https://pepy.tech/project/mdtable)
mdtable is a Python built command line interface that lets you convert csv files into Markdown formatted tables easily. It also provides a Python API to use for your projects.
## Installation
Run ``pip install mdtable`` and check that the latest version is current installed by running ``mdtable —version``.
## Usage
```shell
>>> mdtable [OPTIONS] INPUT_FILE
```
The options available are:
```
-a, --aligns TEXT Comma seperated list of 'l,r,c'
-p, --padding INTEGER Padding for raw Markdown Table formatting
-s, --save TEXT Path to save formatted markdown to
--delimiter TEXT Delimiter character in csv
--quotechar TEXT Quote character in csv
--escapechar TEXT Escape character in csv
--writemode TEXT Python write mode, e.g w+, w, a, a+
--version Show the version and exit.
--help Show this message and exit.
```
**Example**:
Suppose you have a file `input.csv` like so:
```
Name,Department,Birthday Month
John Smith,Accounting,November
Erica Meyers,IT,March
Zain Patel,Engineering,June
Christopher Smith,Engineering,July
Kiseki Hirakawa,Human Resources,February
```
Running ``mdtable input.csv`` results in:
```
| Name | Department | Birthday Month |
| ----------------- | --------------- | -------------- |
| John Smith | Accounting | November |
| Erica Meyers | IT | March |
| Zain Patel | Engineering | June |
| Christopher Smith | Engineering | July |
| Kiseki Hirakawa | Human Resources | February |
```
which looks like:
| Name | Department | Birthday Month |
| ----------------- | --------------- | -------------- |
| John Smith | Accounting | November |
| Erica Meyers | IT | March |
| Zain Patel | Engineering | June |
| Christopher Smith | Engineering | July |
| Kiseki Hirakawa | Human Resources | February |
### API
[*soon*] more documentation
**Example**:
```python
from mdtable import MDTable
markdown = MDTable('in.csv')
markdown_string_table = markdown.get_table()
markdown.save_table('out.csv')
```
### Current Features
- [x] Ability to specify alignments, by providing a comma seperated string of alignments values (either 'l', 'r' or 'c') to ``mdtables —aligns [ALIGNS] INPUT_FILE``, say for example ``mdtables —aligns c,c,l input.csv``, there must be as many alignments characters as there are tables.
- [x] Ability to save output to a markdown file (and specify the writing mode) by providing the path to the file you wish to save to ``mdtables —save [SAVE_FILE] INPTUT_FILE`` say for example ``mdtables —save output.md input.csv``
- [x] Provide custom delimiter, quotation and escape characters for reading in your csv file. This is done by providing the character to ``—delimiter, —quotechar, —escapehcar`` respectively.
- [x] Add a padding option to make table border padding customisable (in the raw output). This can now be done. Running `mdtable input.csv -p 3 ` returns
```
| Name | Department | Birthday Month |
| ----------------- | --------------- | -------------- |
| John Smith | Accounting | November |
| Erica Meyers | IT | March |
| Zain Patel | Engineering | June |
| Christopher Smith | Engineering | July |
| Kiseki Hirakawa | Human Resources | February |
```
- [ ]
## Future Features
- [ ] Implement a centering flag (for raw output) to prettify the output if required
- [ ] Enable 0 padding
- [ ] Add documentation for the API
- [ ] Implement tests for `delimeters``, quotechars` and `escapechars`.