Metadata-Version: 2.2
Name: snap2txt
Version: 0.2.0
Summary: A tool to save project structure and contents to a text file
Home-page: https://github.com/vorniches/snap2txt
Author: Sergei Vorniches
Author-email: vorniches@gmail.com
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: requires-python
Dynamic: summary

# 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:

```bash
pip install snap2txt
```

## Usage

Navigate to your project directory and run:

```bash
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

```text
node_modules/
*.log
```

### Example `.wl` File

```text
*.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](LICENSE).

## Support

For support, questions, or feedback, please [open an issue](https://github.com/yourusername/snap2txt/issues) in the GitHub repository.
