| Name | gptify JSON |
| Version |
0.3.6
JSON |
| download |
| home_page | None |
| Summary | Convert code repos into an LLM prompt-friendly format. Forked from https://github.com/zackees/gptrepo |
| upload_time | 2024-11-15 18:03:40 |
| maintainer | None |
| docs_url | None |
| author | Wilder Lopes |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# gptify
`gptify` is a command-line tool that transforms a Git repository into a single text file suitable for use with Large Language Models (LLMs) like ChatGPT. It preserves the file structure and content, enabling LLMs to understand and process the codebase for tasks such as code review, documentation generation, and answering questions about the code. This project is a fork of [gptrepo](https://github.com/zackess/gptrepo) with added features specifically designed for the [miniogre devtool](https://github.com/ogre-run/miniogre).
## Relevance
This tool addresses the challenge of effectively using LLMs with codebases. By converting a repository into a digestible format, `gptify` allows developers to leverage the power of LLMs for various development tasks. Within the miniogre project, it plays a crucial role in facilitating AI-driven code understanding and interaction.
## Installation
The easiest way
`pip install gptify`.
`gptify` can also be installed using `pipx`:
```bash
poetry build && pipx install dist/*.whl
```
You can also uninstall older versions using the provided install script: `./install.sh`.
## Usage
After installation, navigate to the root directory of your Git repository and run:
```bash
gptify
```
This command will generate a file named `gptify_output.txt` in the current directory containing the formatted repository content. You can then copy and paste the contents of this file into a ChatGPT session to interact with your codebase.
### Options
* `--output <filename>`: Specifies the name of the output file (default: `gptify_output.txt`).
* `--clipboard`: Copies the output directly to the clipboard, omitting the output file creation.
* `--openfile`: Opens the output file after creation using the default system application.
* `--preamble <filepath>`: Prepends a custom preamble to the output file.
## Example with custom output file:
```bash
gptify --output my_repo.txt
```
This will generate `my_repo.txt` with the processed repository data.
## Contributing
While contributions are welcome, the focus of this fork is on specific features for miniogre, and responses to pull requests might be delayed.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "gptify",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Wilder Lopes",
"author_email": "wilder@ogre.run",
"download_url": "https://files.pythonhosted.org/packages/a7/91/69cb237c68ec971ded8de65d0b8f98910886a3442099c20b6196dfb61d9e/gptify-0.3.6.tar.gz",
"platform": null,
"description": "# gptify\n\n`gptify` is a command-line tool that transforms a Git repository into a single text file suitable for use with Large Language Models (LLMs) like ChatGPT. It preserves the file structure and content, enabling LLMs to understand and process the codebase for tasks such as code review, documentation generation, and answering questions about the code. This project is a fork of [gptrepo](https://github.com/zackess/gptrepo) with added features specifically designed for the [miniogre devtool](https://github.com/ogre-run/miniogre).\n\n## Relevance\n\nThis tool addresses the challenge of effectively using LLMs with codebases. By converting a repository into a digestible format, `gptify` allows developers to leverage the power of LLMs for various development tasks. Within the miniogre project, it plays a crucial role in facilitating AI-driven code understanding and interaction.\n\n## Installation\n\nThe easiest way\n`pip install gptify`.\n\n`gptify` can also be installed using `pipx`:\n\n```bash\npoetry build && pipx install dist/*.whl\n```\nYou can also uninstall older versions using the provided install script: `./install.sh`.\n\n## Usage\n\nAfter installation, navigate to the root directory of your Git repository and run:\n\n```bash\ngptify\n```\n\nThis command will generate a file named `gptify_output.txt` in the current directory containing the formatted repository content. You can then copy and paste the contents of this file into a ChatGPT session to interact with your codebase.\n\n### Options\n\n* `--output <filename>`: Specifies the name of the output file (default: `gptify_output.txt`).\n* `--clipboard`: Copies the output directly to the clipboard, omitting the output file creation.\n* `--openfile`: Opens the output file after creation using the default system application.\n* `--preamble <filepath>`: Prepends a custom preamble to the output file.\n\n## Example with custom output file:\n\n```bash\ngptify --output my_repo.txt\n```\n\nThis will generate `my_repo.txt` with the processed repository data.\n\n## Contributing\n\nWhile contributions are welcome, the focus of this fork is on specific features for miniogre, and responses to pull requests might be delayed.\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Convert code repos into an LLM prompt-friendly format. Forked from https://github.com/zackees/gptrepo",
"version": "0.3.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28869e64fd023bec68e5b321f46932ea9efc02a4f75a5630dfdbb94f5c10906f",
"md5": "b5a5d855d6898ad9fb2135af15d811aa",
"sha256": "db0ddc097d39c10b868c5d081a24310162e864d685aa55e740d6f2440b9452a8"
},
"downloads": -1,
"filename": "gptify-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b5a5d855d6898ad9fb2135af15d811aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4869,
"upload_time": "2024-11-15T18:03:39",
"upload_time_iso_8601": "2024-11-15T18:03:39.167342Z",
"url": "https://files.pythonhosted.org/packages/28/86/9e64fd023bec68e5b321f46932ea9efc02a4f75a5630dfdbb94f5c10906f/gptify-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a79169cb237c68ec971ded8de65d0b8f98910886a3442099c20b6196dfb61d9e",
"md5": "d033ffcd01c6156cb0e3ac55dcfcacf3",
"sha256": "cf4543eb2806148a0c949ca52c3385484ddcedd3b70587db1f5c98280600627d"
},
"downloads": -1,
"filename": "gptify-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "d033ffcd01c6156cb0e3ac55dcfcacf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3802,
"upload_time": "2024-11-15T18:03:40",
"upload_time_iso_8601": "2024-11-15T18:03:40.732130Z",
"url": "https://files.pythonhosted.org/packages/a7/91/69cb237c68ec971ded8de65d0b8f98910886a3442099c20b6196dfb61d9e/gptify-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 18:03:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gptify"
}
