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
  • Local Installation
• Usage
• Requirements
• Contributing
• License
• Changelog

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

1. Clean the dist directory to prevent old distributions:

rm -r dist/*

2. Package the project:

python setup.py sdist bdist_wheel

3. 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.