CLI tool to extract the structure of a project into a .txt file.
Project description
Project Structure Extractor
A command-line interface (CLI) tool to extract the structure of a project into a .txt
file. It allows users to include or exclude hidden folders/files and specify files or folders to ignore.
Table of Contents
Installation
Development Installation
For those contributing and making changes to the codebase, it's often more efficient to install the package in 'editable' mode. This way, changes you make to the source immediately reflect in the installed package.
To install in editable mode:
python setup.py develop
This will set up a link to your source code, so you won't have to repackage and reinstall every time you make a change.
Local Installation
- Clean the
dist
directory to prevent old distributions:
rm -r dist/*
- Package the project:
python setup.py sdist bdist_wheel
- Install the packaged distribution (Note: the version might depend on what is set in
setup.py
):
pip install --upgrade dist/project-structure-extractor-0.1.0.tar.gz
Usage
After installation, you can run the extract-structure
directly from the CLI.
To extract the structure of a project, use:
extract-structure --path path_to_project_directory
Options available:
--path
(default: current directory): Path to the project directory.--hidden-included
: If set, include hidden folders/files in the structure.--ignore
: Comma-separated list of files or folders to ignore.
For example, to extract the structure including hidden files but ignoring a specific folder:
extract-structure --path ./my_project --hidden-included --ignore node_modules,build
Requirements
- Python 3.x
- Other dependencies can be found in the
requirements.txt
file.
Contributing
For contributions, please create a fork, make your changes, and submit a pull request. Details on the development setup and guidelines can be found in the CONTRIBUTING.md file.
Once pull requests are approved and merged, maintainers will handle versioning and releases. New releases on GitHub will automatically trigger package updates on PyPI via GitHub Actions.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Changelog
For a detailed history of changes, see CHANGELOG.md.
- 0.1.0 - Initial release with basic features.
- 0.1.1 - No foundational changes, more a lean towards automation builds
- ... - ... (and so on for a few recent versions)
For any issues or contributions, please open an issue or pull request.
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
Built Distribution
Hashes for project-structure-extractor-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03b0aea892714aaaef50a7f6bc58dd5009fd3b969ccb431017aaa0c3e9289ef6 |
|
MD5 | e8d6f7d9f3323039bed593ae7e336585 |
|
BLAKE2b-256 | c359f37dde858afd97c2c86d5e92138eadf3d0c5278f8a1847a3cefa9c527e06 |
Hashes for project_structure_extractor-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9383a2ffd924a522903e8801596f54b481f50b2cb18b1f02049c94b7b5ca63f7 |
|
MD5 | 314d71254783d21481d7ab833e9231d2 |
|
BLAKE2b-256 | 34640a4c22a169f3a274fda49266ef945207071d273ee4a922b4bf61fc554853 |