Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atharva-gundawar/repostruc
REPOSTRUC returns directory structure to your Clipboard or saves it to a file, default : PROJECTINFO.md
https://github.com/atharva-gundawar/repostruc
documentation project-management project-structure readme structure tree
Last synced: 10 days ago
JSON representation
REPOSTRUC returns directory structure to your Clipboard or saves it to a file, default : PROJECTINFO.md
- Host: GitHub
- URL: https://github.com/atharva-gundawar/repostruc
- Owner: Atharva-Gundawar
- License: mit
- Created: 2021-05-26T18:25:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-29T16:18:57.000Z (over 3 years ago)
- Last Synced: 2025-01-19T10:09:27.822Z (15 days ago)
- Topics: documentation, project-management, project-structure, readme, structure, tree
- Language: Python
- Homepage: https://pypi.org/project/repostruc/0.0.5/
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# REPOSTRUC
>`repostruc` is a cross-platform library that returns the directory structure in a formated form. The structure can be copied to your clipboard or a .md file can be made available.[`.md example`](PROJECTINFO.md)
## Ignored files
>`repostruc` ignores files from [`.gitinore`](.gitinore) file if present else ignores commonly ignored files and directories.
## Install the Requirements
```bash
pip install repostruc
```
## Usage
### To clipboard
```bash
repostruc -c
```
### To file
```bash
repostruc -f filepath
```
### To [`PROJECTINFO.md`](PROJECTINFO.md)
```bash
repostruc -r -f
```
## Example
View [`PROJECTINFO.md`](PROJECTINFO.md) which was made using `repostruc`
## Built With
* [`pathlib`](https://pypi.org/project/pathlib/) - pathlib offers a set of classes to handle filesystem paths.
* [`pyperclip`](https://pypi.org/project/pyperclip3/) - Cross-platform clipboard utilities supporting both binary and text data.
* [`gitignore_parser`](https://pypi.org/project/gitignore-parser/) - A spec-compliant gitignore parser for Python 3.5+
* [`docopt`](https://pypi.org/project/docopt/) - creates beautiful command-line interfaces
## Contributing
Please read [CONTRIBUTING.md](https://github.com/) for details on our code of conduct, and the process for submitting pull requests.
## Authors
* **Atharva Gundawar** - *Initial work* - [Github handle](https://github.com/Atharva-Gundawar)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Generator function from [*Aaron Hall's*](https://stackoverflow.com/users/541136/aaron-hall) answer [here](https://stackoverflow.com/questions/9727673/list-directory-tree-structure-in-python)