Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/earnestt1234/seedir
A Python package for creating, editing, and reading folder tree diagrams
https://github.com/earnestt1234/seedir
folder-structure python
Last synced: about 1 month ago
JSON representation
A Python package for creating, editing, and reading folder tree diagrams
- Host: GitHub
- URL: https://github.com/earnestt1234/seedir
- Owner: earnestt1234
- License: mit
- Created: 2020-07-28T17:39:08.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T03:29:32.000Z (over 1 year ago)
- Last Synced: 2024-05-09T18:12:57.922Z (about 2 months ago)
- Topics: folder-structure, python
- Language: Python
- Homepage:
- Size: 3.53 MB
- Stars: 110
- Watchers: 5
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-stars - seedir - A Python package for creating, editing, and reading folder tree diagrams (Python)
README
# seedir
A Python package for creating, editing, and reading folder tree diagrams.
*Photo by [Adam Kring](https://unsplash.com/@adamkring).*
```python
>>> 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`](https://pypi.org/project/seedir/):
```
pip install seedir
```
To make use of the 'emoji' style, install [emoji](https://pypi.org/project/emoji/) (`pip install emoji`) or use `pip install seedir[emoji]`.
## Usage
See the [API documentation](https://earnestt1234.github.io/seedir/seedir/index.html) (generated with [pdoc3](https://pdoc3.github.io/pdoc/)).
## License
Open source under MIT.