/seedir

A Python package for creating, editing, and reading folder tree diagrams

Primary LanguagePythonMIT LicenseMIT

seedir

A Python package for creating, editing, and reading folder tree diagrams.

Photo by Adam Kring.

>>> import seedir as sd
>>> sd.seedir(style='lines', itemlimit=10, depthlimit=2, exclude_folders='.git')
seedir/
├─.gitattributes
├─.gitignore
├─.ipynb_checkpoints/
│ └─examples-checkpoint.ipynb
├─build/
│ ├─bdist.win-amd64/
│ └─lib/
├─CHANGELOG.md
├─dist/
│ └─seedir-0.1.4-py3-none-any.whl
├─docs/
│ ├─exampledir/
│ ├─gettingstarted.md
│ ├─seedir/
│ └─templates/
├─img/
│ ├─pun.jpg
│ ├─seedir_diagram.png
│ └─seedir_diagram.pptx
├─LICENSE
└─MANIFEST.in

Installation

Available with pip:

pip install seedir

To make use of the 'emoji' style, install emoji (pip install emoji) or use pip install seedir[emoji].

Usage

See the API documentation (generated with pdoc3).

License

Open source under MIT.