talk-codebase/README.md

# talk-codebase is a powerful tool for chatting with your codebase

[![Node.js Package](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml)

<p align="center">
  <img src="https://github.com/rsaryev/talk-codebase/assets/70219513/6d92e905-fb1b-4235-857b-e6e19041ad79" width="800" alt="chat">
</p>
 
## Description

In the chat, you can ask questions about the codebase. AI will answer your questions, and if necessary, it will offer
code improvements. This is very convenient when you want to quickly find something in the codebase, but don't want to
waste time searching. It is also convenient when you want to improve a specific function, you can ask "How can I improve
the function {function name}?" and AI will suggest improvements. Codebase is analyzed using openai.

## Installation

```bash
pip install talk-codebase
```

## Usage

talk-codebase works only with files of popular programming languages and additionally with .txt files. All other files
will be ignored.

```bash
# Start chatting with your codebase
talk-codebase chat <directory>

# Configure
talk-codebase configure

# Help
talk-codebase --help
```
Add CLI for chatting with OpenAI model - Add CLI functionality for chatting with OpenAI model - Implement function to allow users to input OpenAI API key and model name - Implement function to allow users to chat with OpenAI model using retrieved documents - Add module to handle sending questions to OpenAI model - Add module to load and split text documents, create retriever, and define StreamStdOut callback class 1 year ago			`# talk-codebase is a powerful tool for chatting with your codebase`
Refactor text loader and add repo check - Refactored the text loader in utils.py to improve readability and maintainability. - Added a new function called in utils.py to check if the current directory is a git repository. - Modified the function in utils.py to ignore files and directories ignored by git. - Added error handling to function in utils.py to return if the current directory is not a git repository. 1 year ago
Update README.md 1 year ago			`[![Node.js Package](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rsaryev/talk-codebase/actions/workflows/python-publish.yml)`
Add CLI for chatting with OpenAI model - Add CLI functionality for chatting with OpenAI model - Implement function to allow users to input OpenAI API key and model name - Implement function to allow users to chat with OpenAI model using retrieved documents - Add module to handle sending questions to OpenAI model - Add module to load and split text documents, create retriever, and define StreamStdOut callback class 1 year ago
			`<p align="center">`
Add spinner to indicate loading files - Added a spinner using the Halo package to indicate when files are being loaded. - The spinner appears while the load_files function is running and disappears once the function has completed. - This should improve the user experience by providing feedback that the program is actively doing something. 1 year ago			`<img src="https://github.com/rsaryev/talk-codebase/assets/70219513/6d92e905-fb1b-4235-857b-e6e19041ad79" width="800" alt="chat">`
Add CLI for chatting with OpenAI model - Add CLI functionality for chatting with OpenAI model - Implement function to allow users to input OpenAI API key and model name - Implement function to allow users to chat with OpenAI model using retrieved documents - Add module to handle sending questions to OpenAI model - Add module to load and split text documents, create retriever, and define StreamStdOut callback class 1 year ago			`</p>`
Refactor text loader and add repo check - Refactored the text loader in utils.py to improve readability and maintainability. - Added a new function called in utils.py to check if the current directory is a git repository. - Modified the function in utils.py to ignore files and directories ignored by git. - Added error handling to function in utils.py to return if the current directory is not a git repository. 1 year ago
Add CLI for chatting with OpenAI model - Add CLI functionality for chatting with OpenAI model - Implement function to allow users to input OpenAI API key and model name - Implement function to allow users to chat with OpenAI model using retrieved documents - Add module to handle sending questions to OpenAI model - Add module to load and split text documents, create retriever, and define StreamStdOut callback class 1 year ago			`## Description`

Refactor text loader and add repo check - Refactored the text loader in utils.py to improve readability and maintainability. - Added a new function called in utils.py to check if the current directory is a git repository. - Modified the function in utils.py to ignore files and directories ignored by git. - Added error handling to function in utils.py to return if the current directory is not a git repository. 1 year ago			`In the chat, you can ask questions about the codebase. AI will answer your questions, and if necessary, it will offer`
			`code improvements. This is very convenient when you want to quickly find something in the codebase, but don't want to`
			`waste time searching. It is also convenient when you want to improve a specific function, you can ask "How can I improve`
			`the function {function name}?" and AI will suggest improvements. Codebase is analyzed using openai.`
Add CLI for chatting with OpenAI model - Add CLI functionality for chatting with OpenAI model - Implement function to allow users to input OpenAI API key and model name - Implement function to allow users to chat with OpenAI model using retrieved documents - Add module to handle sending questions to OpenAI model - Add module to load and split text documents, create retriever, and define StreamStdOut callback class 1 year ago
			`## Installation`

			```bash
			`pip install talk-codebase`
			```

			`## Usage`

Refactor text loader and add repo check - Refactored the text loader in utils.py to improve readability and maintainability. - Added a new function called in utils.py to check if the current directory is a git repository. - Modified the function in utils.py to ignore files and directories ignored by git. - Added error handling to function in utils.py to return if the current directory is not a git repository. 1 year ago			`talk-codebase works only with files of popular programming languages and additionally with .txt files. All other files`
			`will be ignored.`

Add CLI for chatting with OpenAI model - Add CLI functionality for chatting with OpenAI model - Implement function to allow users to input OpenAI API key and model name - Implement function to allow users to chat with OpenAI model using retrieved documents - Add module to handle sending questions to OpenAI model - Add module to load and split text documents, create retriever, and define StreamStdOut callback class 1 year ago			```bash
			`# Start chatting with your codebase`
			`talk-codebase chat <directory>`

			`# Configure`
			`talk-codebase configure`

			`# Help`
			`talk-codebase --help`
			```