Package to generate different kind of markdown texts
Project description
MD Generator (mdgenerator)
mdgenerator is a package to generate different kinds of markdown texts
Following details the functionality provided by the package:
- Generate File Structure Trees in Markdown
- Generate Tables in Markdown from pandas dataframe or python arrays
Installation
There are two ways to install mdgenerator:
- Install mdgenerator from PyPI (recommended):
pip install mdgenerator
- Install mdgenerator from the Github source:
git clone https://github.com/nilansaha/mdgenerator.git
cd mdgenerator
pip install .
Usage
-
Generate File Tree Structure in Markdown
- Using Python
from mdgenerator import generate_file_structure generate_file_structure(target_dir='/path/to/directory', output_dir='/output/directory')
- Using the terminal
mdgenerator --target_dir "/path/to/directory" --output_dir "/output/directory"
Output is stored in
file_structure.md
in the specifiedoutput_dir
Sample Output -
├── .DS_Store ├── mdgenerator.py ├── __init__.py ├── test.py ├── cli.py ├── file-structure.md ├── ABC | ├── a.txt | ├── BCD | | ├── b.txt ├── __pycache__ | ├── mdgenerator.cpython-37.pyc
-
Generate Markdown Table using Python
- Using Python lists
from mdgenerator import generate_table data = [['Word_1','Word_2'],['Happy','Sad'],['Nice','Bad']] table = generate_table(data) print(table)
Output
Word_1 Word_2 Happy Sad Nice Bad - Using Pandas DataFrame
import pandas as pd from mdgenerator import generate_table df = pd.DataFrame([['Happy','Sad'], ['Nice','Bad']], columns = ['Word_1','Word_2']) table = generate_table(df) print(table)
Output
Word_1 Word_2 Happy Sad Nice Bad
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
mdgenerator-0.1.0.tar.gz
(2.7 kB
view hashes)
Built Distribution
Close
Hashes for mdgenerator-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db13f67a42746d01af4b4d7a90033095f58559dc1c0db897bc8954c0ddcc9dfc |
|
MD5 | 66ea307b81778adcf85a5bda99faa047 |
|
BLAKE2b-256 | 21938eff4803a352058726d00bd19731c6d99d765b873eb50b8312e0b6d672d9 |