snap2txt 0.1.0

A tool to save project structure and contents to a text file

Snap2Txt

Snap2Txt is a Python utility that captures the structure and contents of a project directory and saves them into a text file. It's designed for quick documentation of your project's file system.

Features

• Complete Capture: Records the entire file structure and contents of the project.
• Customizable Filters: Offers ignore and whitelist options for targeted scanning.
• Command-Line Interface: Simple and easy-to-use command-line tool.

Installation

Install Snap2Txt with pip:

pip install snap2txt

Usage

Navigate to your project directory and run:

snap2txt

Optional Flags

• --il: Use an ignore list from a .il file.
• --wl: Use a whitelist from a .wl file.

Configuration

Create .il and .wl files in your project directory to specify patterns to ignore or include, respectively.

Example .il File

node_modules/
*.log

Example .wl File

*.py
*.md

Contributing

Contributions to Snap2Txt are welcome! Feel free to fork the repository, make your changes, and submit a pull request.

License

Snap2Txt is open-sourced software licensed under the MIT license.

Support

For support, questions, or feedback, please open an issue in the GitHub repository.