Directory structure diagram generator
Project description
Description
dirtree-chart is a tiny tool for creating folder structure diagrams based on mermaids markdown syntax.
The output will be saved in an seperate .mmd
file or may be included in a README.md
. The idea behind dirtree-chart
is to simple include it in your build tasks for generic charts in your repository.
In the future, image output (svg
, png
, pdf
, ...) will be implemented.
Installation
pip install dirtree-chart
Usage and Examples
- To get information about the tool run
python -m dirtree_chart -h
in the command line. - For big projects it should be considered to limit the folder depth to a suitable level (e.g.
-md 3
). - Files which should not be includes may be put into the ignore list (
-il file1, file2
). At the moment no wildcard definition is supported. - For git project the mermaid output markdown may be written to the
README.md
file (-i true
). Currently only the file extention .md is supported. - Define the direction of the graph (
-d TD
). TD = Top-Down, LR = Left-Right.
Scripts
from dirtree_chart import diagram
from dirtree_chart import config
# Add files or folders to ignore list
ignore_list = config.ignore_list.copy()
ignore_list.extend([".secrets", "ect.f"])
# Create diagram
diagram.DirStrucTree(ignore = ignore_list)
Command line
python -m dirtree_chart [-h] [-r ROOT] [-i INCLUDE_TO_README] [-d DIRECTION] [-md MAXDEPTH] [-il IGNORELIST [IGNORELIST ...]
Todos
- Image format (svg, png, ...) output
- Ignore list should accept regex
Author
Manuel Strohmaier / 2021
License
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for dirtree_chart-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46cbaf15b712f4bcc207df5579be741597a106612215ec051e3abda5d899b25a |
|
MD5 | 9eac0105fb093400b00e9c113381aa2b |
|
BLAKE2b-256 | 5fe959b092cb60e8f6c32c51369b0b4482bd16f04af41a8bc8ebeac441fc06b3 |