https://github.com/javitocor/python-direcory-tree-generator
A Directory Tree Generator for the command line.
https://github.com/javitocor/python-direcory-tree-generator
argparse directory-tree pathlib python
Last synced: 5 months ago
JSON representation
A Directory Tree Generator for the command line.
- Host: GitHub
- URL: https://github.com/javitocor/python-direcory-tree-generator
- Owner: javitocor
- License: mit
- Created: 2021-07-20T19:33:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-20T19:44:32.000Z (over 4 years ago)
- Last Synced: 2025-03-24T09:23:43.919Z (about 1 year ago)
- Topics: argparse, directory-tree, pathlib, python
- Language: Python
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
# Python Directory Tree Generator
> A Directory Tree Generator for the command line.
Additional description about the project and its features.
## Built With
- PYTHON
- PATHLIB
- ARGPARSE
- GITHUB ACTIONS
- VSCODE
## Getting Started
### Usage
To have this app on your pc, you need to:
* [download](https://github.com/javitocor/Python-Direcory-Tree-Generator/archive/development.zip) or clone this repo:
- Clone with SSH:
```
git@github.com:javitocor/Python-Direcory-Tree-Generator.git
```
- Clone with HTTPS
```
https://github.com/javitocor/Python-Direcory-Tree-Generator.git
```
## Options
- Use ´python tree.py´ + ´directory´ in your CLI
- -v, --version show the current version information and exit the application.
- -h, --help show help and usage messages.
- -d, --dir-only generate a directory-only tree and print it into the screen.
- -o, --output-to-markdown generate a tree and save it to a file in markdown format.´(python tree.py + dir + -o output_file.md)´
## Author
👤 Javier Oriol Correas Sanchez Cuesta
- Github: [@javitocor](https://github.com/javitocor)
- Twitter: [@JavierCorreas4](https://twitter.com/JavierCorreas4)
- Linkedin: [Javier Oriol Correas Sanchez Cuesta](https://www.linkedin.com/in/javier-correas-sanchez-cuesta-15289482/)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](https://github.com/javitocor/Python-Direcory-Tree-Generator/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments 🚀
- Python Docs
- Real Python
## 📝 License
This project is [MIT](lic.url) licensed.
[contributors-shield]: https://img.shields.io/github/contributors/javitocor/Python-Direcory-Tree-Generator.svg?style=flat-square
[contributors-url]: https://github.com/javitocor/Python-Direcory-Tree-Generator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/javitocor/Python-Direcory-Tree-Generator.svg?style=flat-square
[forks-url]: https://github.com/javitocor/Python-Direcory-Tree-Generator/network/members
[stars-shield]: https://img.shields.io/github/stars/javitocor/Python-Direcory-Tree-Generator.svg?style=flat-square
[stars-url]: https://github.com/javitocor/Python-Direcory-Tree-Generator/stargazers
[issues-shield]: https://img.shields.io/github/issues/javitocor/Python-Direcory-Tree-Generator.svg?style=flat-square
[issues-url]: https://github.com/javitocor/Python-Direcory-Tree-Generator/issuesover: