| Name | talk-codebase JSON |
| Version |
0.1.50
JSON |
| download |
| home_page | |
| Summary | talk-codebase is a powerful tool for querying and analyzing codebases. |
| upload_time | 2023-11-06 11:37:37 |
| maintainer | |
| docs_url | None |
| author | Saryev Rustam |
| requires_python | >=3.8.1,<4.0 |
| license | |
| keywords |
chatgpt
openai
cli
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# talk-codebase
[](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml)
Talk-codebase is a tool that allows you to converse with your codebase using Large Language Models (LLMs) to answer your
queries. It supports offline code processing using LlamaCpp and [GPT4All](https://github.com/nomic-ai/gpt4all) without
sharing your code with third parties, or you can use OpenAI if privacy is not a concern for you. Please note that
talk-codebase is still under development and is recommended for educational purposes, not for production use.
<p align="center">
<img src="https://github.com/rsaryev/talk-codebase/assets/70219513/b5d338f9-14a5-417b-9690-83f5cd66facf" width="800" alt="chat">
</p>
## Installation
Requirement Python 3.8.1 or higher
Your project must be in a git repository
```bash
pip install talk-codebase
```
After installation, you can use it to chat with your codebase in the current directory by running the following command:
```bash
talk-codebase chat <path>
```
Select model type: Local or OpenAI
<img width="300" alt="select_type" src="https://github.com/rsaryev/talk-codebase/assets/70219513/05196fe5-78ff-44ff-8ca3-0313ccef572a">
OpenAI
If you use the OpenAI model, you need an OpenAI API key. You can get it from [here](https://beta.openai.com/). Then you
will be offered a choice of available models.
<img width="300" alt="select" src="https://github.com/rsaryev/talk-codebase/assets/70219513/889ad7c8-a489-4ce8-83af-148b7df09229">
Local
<img width="696" alt="Снимок экрана 2023-07-12 в 03 47 58" src="https://github.com/rsaryev/talk-codebase/assets/70219513/16988911-c605-4570-bfb4-4a34a03cd4a1">
If you want some files to be ignored, add them to .gitignore.
## Reset configuration
To reset the configuration, run the following command:
```bash
talk-codebase configure
```
## Advanced configuration
You can manually edit the configuration by editing the `~/.config.yaml` file. If you cannot find the configuration file,
run the tool and it will output the path to the configuration file at the very beginning.
## Supported Extensions
- [x] `.csv`
- [x] `.doc`
- [x] `.docx`
- [x] `.epub`
- [x] `.md`
- [x] `.pdf`
- [x] `.txt`
- [x] `popular programming languages`
## Contributing
* If you find a bug in talk-codebase, please report it on the project's issue tracker. When reporting a bug, please
include as much information as possible, such as the steps to reproduce the bug, the expected behavior, and the actual
behavior.
* If you have an idea for a new feature for Talk-codebase, please open an issue on the project's issue tracker. When
suggesting a feature, please include a brief description of the feature, as well as any rationale for why the feature
would be useful.
* You can contribute to talk-codebase by writing code. The project is always looking for help with improving the
codebase, adding new features, and fixing bugs.
Raw data
{
"_id": null,
"home_page": "",
"name": "talk-codebase",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "chatgpt,openai,cli",
"author": "Saryev Rustam",
"author_email": "rustam1997@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ac/0b/d987c9be0b8a7f00289d060e53ff5d36f8f86188716ecb846873b0dd291c/talk_codebase-0.1.50.tar.gz",
"platform": null,
"description": "# talk-codebase\n\n[](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml)\n\nTalk-codebase is a tool that allows you to converse with your codebase using Large Language Models (LLMs) to answer your\nqueries. It supports offline code processing using LlamaCpp and [GPT4All](https://github.com/nomic-ai/gpt4all) without\nsharing your code with third parties, or you can use OpenAI if privacy is not a concern for you. Please note that\ntalk-codebase is still under development and is recommended for educational purposes, not for production use.\n\n<p align=\"center\">\n <img src=\"https://github.com/rsaryev/talk-codebase/assets/70219513/b5d338f9-14a5-417b-9690-83f5cd66facf\" width=\"800\" alt=\"chat\">\n</p>\n\n## Installation\n\nRequirement Python 3.8.1 or higher\nYour project must be in a git repository\n\n```bash\npip install talk-codebase\n```\n\nAfter installation, you can use it to chat with your codebase in the current directory by running the following command:\n\n```bash\ntalk-codebase chat <path>\n```\n\nSelect model type: Local or OpenAI\n\n<img width=\"300\" alt=\"select_type\" src=\"https://github.com/rsaryev/talk-codebase/assets/70219513/05196fe5-78ff-44ff-8ca3-0313ccef572a\">\n\nOpenAI\n\nIf you use the OpenAI model, you need an OpenAI API key. You can get it from [here](https://beta.openai.com/). Then you\nwill be offered a choice of available models.\n\n<img width=\"300\" alt=\"select\" src=\"https://github.com/rsaryev/talk-codebase/assets/70219513/889ad7c8-a489-4ce8-83af-148b7df09229\">\n\n\nLocal\n\n<img width=\"696\" alt=\"\u0421\u043d\u0438\u043c\u043e\u043a \u044d\u043a\u0440\u0430\u043d\u0430 2023-07-12 \u0432 03 47 58\" src=\"https://github.com/rsaryev/talk-codebase/assets/70219513/16988911-c605-4570-bfb4-4a34a03cd4a1\">\n\nIf you want some files to be ignored, add them to .gitignore.\n\n## Reset configuration\n\nTo reset the configuration, run the following command:\n\n```bash\ntalk-codebase configure\n```\n\n## Advanced configuration\n\nYou can manually edit the configuration by editing the `~/.config.yaml` file. If you cannot find the configuration file,\nrun the tool and it will output the path to the configuration file at the very beginning.\n\n## Supported Extensions\n\n- [x] `.csv`\n- [x] `.doc`\n- [x] `.docx`\n- [x] `.epub`\n- [x] `.md`\n- [x] `.pdf`\n- [x] `.txt`\n- [x] `popular programming languages`\n\n## Contributing\n\n* If you find a bug in talk-codebase, please report it on the project's issue tracker. When reporting a bug, please\n include as much information as possible, such as the steps to reproduce the bug, the expected behavior, and the actual\n behavior.\n* If you have an idea for a new feature for Talk-codebase, please open an issue on the project's issue tracker. When\n suggesting a feature, please include a brief description of the feature, as well as any rationale for why the feature\n would be useful.\n* You can contribute to talk-codebase by writing code. The project is always looking for help with improving the\n codebase, adding new features, and fixing bugs.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "talk-codebase is a powerful tool for querying and analyzing codebases.",
"version": "0.1.50",
"project_urls": null,
"split_keywords": [
"chatgpt",
"openai",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62675c558251fae371c11af7694936543d9b001c671c740a4774c28f1ac5a22e",
"md5": "90cb20455aeba0f0663b7f4703265c32",
"sha256": "043132d42f9be963d573c0a92f3bc83e310156c62253bfd07ef30254c90dad31"
},
"downloads": -1,
"filename": "talk_codebase-0.1.50-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90cb20455aeba0f0663b7f4703265c32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 9439,
"upload_time": "2023-11-06T11:37:35",
"upload_time_iso_8601": "2023-11-06T11:37:35.369593Z",
"url": "https://files.pythonhosted.org/packages/62/67/5c558251fae371c11af7694936543d9b001c671c740a4774c28f1ac5a22e/talk_codebase-0.1.50-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac0bd987c9be0b8a7f00289d060e53ff5d36f8f86188716ecb846873b0dd291c",
"md5": "7630ee878acd791451130d36897c4bd4",
"sha256": "b3d5964fbea940cfebb83221e7d4317c2ab8533164e9c7011f3818097fe18bd0"
},
"downloads": -1,
"filename": "talk_codebase-0.1.50.tar.gz",
"has_sig": false,
"md5_digest": "7630ee878acd791451130d36897c4bd4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 7489,
"upload_time": "2023-11-06T11:37:37",
"upload_time_iso_8601": "2023-11-06T11:37:37.078854Z",
"url": "https://files.pythonhosted.org/packages/ac/0b/d987c9be0b8a7f00289d060e53ff5d36f8f86188716ecb846873b0dd291c/talk_codebase-0.1.50.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-06 11:37:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "talk-codebase"
}
