repo-to-text

repo-to-text is an open-source project that converts the structure and contents of a directory (repository) into a single text file. By executing a simple command in the terminal, this tool generates a text representation of the directory, including the output of the tree command and the contents of each file, formatted for easy reading and sharing.

Features

• Generates a text representation of a directory's structure.
• Includes the output of the tree command.
• Saves the contents of each file, encapsulated in markdown code blocks.
• Copies the generated text representation to the clipboard for easy sharing.
• Easy to install and use via pip and Homebrew.

Installation

Using pip

To install repo-to-text via pip, run the following command:

pip install git+https://github.com/yourusername/repo-to-text.git

Using Homebrew

To install repo-to-text via Homebrew, run the following command:

brew install yourusername/repo-to-text

Install Locally

To install repo-to-text locally for development, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/repo-to-text.git
   cd repo-to-text
   

2. Install the package locally:

   pip install -e .
   

Installing Dependencies

To install all the required dependencies, run the following command:

pip install -r requirements.txt

Usage

After installation, you can use the repo-to-text command in your terminal. Navigate to the directory you want to convert and run:

repo-to-text

This will create a file named repo_snapshot.txt in the current directory with the text representation of the repository. The contents of this file will also be copied to your clipboard for easy sharing.

Enabling Debug Logging

By default, repo-to-text runs with INFO logging level. To enable DEBUG logging, use the --debug flag:

repo-to-text --debug

Example Output

The generated text file will include the directory structure and contents of each file. For a full example, see the example output.

Running Tests

To run the tests, use the following command:

pytest

Make sure you have pytest installed. If not, you can install it using:

pip install -r requirements.txt

Uninstall Locally

To uninstall the locally installed package, run the following command from the directory where the repository is located:

pip uninstall repo-to-text

Contributing

Contributions are welcome! If you have any suggestions or find a bug, please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any inquiries or feedback, please contact yourname.