Metadata-Version: 2.1
Name: gptrepo
Version: 1.0.1
Summary: gpt repository loader
Home-page: https://github.com/zackees/gptrepo
Maintainer: Zachary Vorhies
License: BSD 3-Clause License
Keywords: template-python-cmd
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# gpt-repository-loader

This is a package of the very excellent [gpt-repository-loader](https://github.com/mpoon/gpt-repository-loader) by mpoon.


Usage
```python
pip install gptrepo
gptrepo  # now output.txt should appear in the current directory
```

This tool concatenates through all the files in teh repo and adds ai prompts which can be used for chat gpt conversations.

This will be particularly useful when chat gpt4-32k is release. Right now this will only work on very small repos.

[![Linting](https://github.com/zackees/gptrepo/actions/workflows/lint.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/lint.yml)

[![MacOS_Tests](https://github.com/zackees/gptrepo/actions/workflows/push_macos.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/push_macos.yml)
[![Ubuntu_Tests](https://github.com/zackees/gptrepo/actions/workflows/push_ubuntu.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/push_ubuntu.yml)
[![Win_Tests](https://github.com/zackees/gptrepo/actions/workflows/push_win.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/push_win.yml)

`gpt-repository-loader` is a command-line tool that converts the contents of a Git repository into a text format, preserving the structure of the files and file contents. The generated output can be interpreted by AI language models, allowing them to process the repository's contents for various tasks, such as code review or documentation generation.

## Contributing
Some context around building this is [located here](https://github.com/mpoon/gpt-repository-loader/discussions/18). Appreciate any issues and pull requests in the spirit of having mostly GPT build out this tool. Using [ChatGPT Plus](https://chat.openai.com/) is recommended for quick access to GPT-4.

## Getting Started

To get started with `gpt-repository-loader`, follow these steps:

1. Ensure you have Python 3 installed on your system.
2. Clone or download the `gpt-repository-loader` repository.
3. Navigate to the repository's root directory in your terminal.
4. Run `gpt-repository-loader` with the following command:

   ```bash
   python gpt_repository_loader.py /path/to/git/repository
   ```
    Replace `/path/to/git/repository` with the path to the Git repository you want to process.

5. The tool will generate an output.txt file containing the text representation of the repository. You can now use this file as input for AI language models or other text-based processing tasks.

## Running Tests

To run the tests for `gpt-repository-loader`, follow these steps:

1. Ensure you have Python 3 installed on your system.
2. Navigate to the repository's root directory in your terminal.
3. Run the tests with the following command:

   ```bash
   python -m unittest test_gpt_repository_loader.py
   ```
Now, the test harness is added to the `gpt-repository-loader` project. You can run the tests by executing the command `python -m unittest test_gpt_repository_loader.py` in your terminal.

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