Skip to main content

Python module to generate Directory tree structure.

Project description

Project Title

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repostruc-0.0.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

repostruc-0.0.3-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file repostruc-0.0.3.tar.gz.

File metadata

  • Download URL: repostruc-0.0.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

File hashes

Hashes for repostruc-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f712b595a497ca0fbdc7b1b008ed600ad7b1939940cf8fbe94a794f89a0945ba
MD5 1395b75fa72ba47fa669cebe6f2972cf
BLAKE2b-256 a03d15de07f69846c97d1ecfdcb04c052e2b7668c2dc968048125ca4fea1d9e9

See more details on using hashes here.

File details

Details for the file repostruc-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: repostruc-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.23.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

File hashes

Hashes for repostruc-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9f2239ec34ca0d89450e162331816c49b071027b9b503156699861a8917f163d
MD5 c38f4c1e4db6bdb339feb34482e1238c
BLAKE2b-256 4fea85c3585793886b2bf3e51b9d79df7e37f7a01b2e6ac7e67e49f973f55763

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page