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

Ignored files

repostruc ignores files from .gitinore file if present else ignores commonly ignored files and directories.

Install the Requirements

 pip install repostruc

Usage

To clipboard

repostruc -c

To file

repostruc -f filepath

To PROJECTINFO.md

repostruc -r -f

Example

View PROJECTINFO.md which was made using repostruc

Built With

• pathlib - pathlib offers a set of classes to handle filesystem paths.
• pyperclip - Cross-platform clipboard utilities supporting both binary and text data.
• gitignore_parser - A spec-compliant gitignore parser for Python 3.5+
• docopt - creates beautiful command-line interfaces

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Authors

• Atharva Gundawar - Initial work - Github handle

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Generator function from Aaron Hall's answer here