gptrepo


Namegptrepo JSON
Version 1.0.3 PyPI version JSON
download
home_pagehttps://github.com/zackees/gptrepo
Summarygpt repository loader
upload_time2023-06-26 02:10:16
maintainerZachary Vorhies
docs_urlNone
author
requires_python>=3.7
licenseBSD 3-Clause License
keywords template-python-cmd
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # gptrepo

This is a fork 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 the repo and adds ai prompts which can be used for chat gpt conversations.

Simply open up the file, copy and paste it into the chat gpt window and then ask your question about the code.

This will be particularly useful when chat gpt4-32k is released. 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)

`gptrepo` 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.

## Running Tests

To run the tests for `gptrepo`, 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
   tox
   ```
Now, the test harness is added to the `gptrepo` project. You can run the tests by executing the command `tox` in your terminal.

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

## Versions

  * 1.0.3: Remove media files from concatenation.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/zackees/gptrepo",
    "name": "gptrepo",
    "maintainer": "Zachary Vorhies",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "template-python-cmd",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/ac/0d/045f3df978a3830f6f16e7b9cf1bf3e39f9037d797600020aa75457f80c3/gptrepo-1.0.3.tar.gz",
    "platform": null,
    "description": "# gptrepo\n\nThis is a fork of the very excellent [gpt-repository-loader](https://github.com/mpoon/gpt-repository-loader) by mpoon.\n\n\nUsage\n```python\npip install gptrepo\ngptrepo  # now output.txt should appear in the current directory\n```\n\nThis tool concatenates through all the files in the repo and adds ai prompts which can be used for chat gpt conversations.\n\nSimply open up the file, copy and paste it into the chat gpt window and then ask your question about the code.\n\nThis will be particularly useful when chat gpt4-32k is released. Right now this will only work on very small repos.\n\n[![Linting](https://github.com/zackees/gptrepo/actions/workflows/lint.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/lint.yml)\n\n[![MacOS_Tests](https://github.com/zackees/gptrepo/actions/workflows/push_macos.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/push_macos.yml)\n[![Ubuntu_Tests](https://github.com/zackees/gptrepo/actions/workflows/push_ubuntu.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/push_ubuntu.yml)\n[![Win_Tests](https://github.com/zackees/gptrepo/actions/workflows/push_win.yml/badge.svg)](https://github.com/zackees/gptrepo/actions/workflows/push_win.yml)\n\n`gptrepo` 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.\n\n## Contributing\nSome 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.\n\n## Running Tests\n\nTo run the tests for `gptrepo`, follow these steps:\n\n1. Ensure you have Python 3 installed on your system.\n2. Navigate to the repository's root directory in your terminal.\n3. Run the tests with the following command:\n\n   ```bash\n   tox\n   ```\nNow, the test harness is added to the `gptrepo` project. You can run the tests by executing the command `tox` in your terminal.\n\n## License\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Versions\n\n  * 1.0.3: Remove media files from concatenation.\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License",
    "summary": "gpt repository loader",
    "version": "1.0.3",
    "project_urls": {
        "Homepage": "https://github.com/zackees/gptrepo"
    },
    "split_keywords": [
        "template-python-cmd"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e3121ca030b49784be25cab8ca0c407c0b564be903aa4ebd058541f0f182ecf1",
                "md5": "b9e57c871ac41bee45fa007d4cc4c33d",
                "sha256": "d26bcd9fcd4fa2697ec022ab2a6a09ce28bf3f5ed0b8f220448a16a233027cd4"
            },
            "downloads": -1,
            "filename": "gptrepo-1.0.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b9e57c871ac41bee45fa007d4cc4c33d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 5597,
            "upload_time": "2023-06-26T02:10:14",
            "upload_time_iso_8601": "2023-06-26T02:10:14.870455Z",
            "url": "https://files.pythonhosted.org/packages/e3/12/1ca030b49784be25cab8ca0c407c0b564be903aa4ebd058541f0f182ecf1/gptrepo-1.0.3-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ac0d045f3df978a3830f6f16e7b9cf1bf3e39f9037d797600020aa75457f80c3",
                "md5": "4c404bbb4083bbee1bf447b3735b522d",
                "sha256": "77ee6f28290df5940a30cac910a4ce5b47000a9f74877a29ac6878802236377d"
            },
            "downloads": -1,
            "filename": "gptrepo-1.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4c404bbb4083bbee1bf447b3735b522d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 11667,
            "upload_time": "2023-06-26T02:10:16",
            "upload_time_iso_8601": "2023-06-26T02:10:16.231593Z",
            "url": "https://files.pythonhosted.org/packages/ac/0d/045f3df978a3830f6f16e7b9cf1bf3e39f9037d797600020aa75457f80c3/gptrepo-1.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-26 02:10:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zackees",
    "github_project": "gptrepo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "gptrepo"
}
        
Elapsed time: 0.12000s