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: 2 days 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 (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-25T03:33:53.000Z (5 months ago)
• Last Synced: 2024-09-26T19:49:24.455Z (about 2 months ago)
• Topics: folder-structure, python
• Language: Python
• Homepage:
• Size: 3.39 MB
• Stars: 119
• Watchers: 5
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# seedir

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

![](https://raw.githubusercontent.com/earnestt1234/seedir/master/img/pun.jpg)

*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.