Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bryanoliveira/habla

A coding assistant for entire codebases.
https://github.com/bryanoliveira/habla

anthropic anthropic-claude assistant chatbot claude-api gpt-35-turbo gpt-4 openai openai-api openai-chatgpt python python3

Last synced: about 2 months ago
JSON representation

A coding assistant for entire codebases.

Awesome Lists containing this project

README 

        

    ___       ___       ___       ___       ___   

   /\__\     /\  \     /\  \     /\__\     /\  \  

  /:/__/_   /::\  \   /::\  \   /:/  /    /::\  \ 

 /::\/\__\ /::\:\__\ /::\:\__\ /:/__/    /::\:\__\

 \/\::/  / \/\::/  / \:\::/  / \:\  \    \/\::/  /

   /:/  /    /:/  /   \::/  /   \:\__\     /:/  / 

   \/__/     \/__/     \/__/     \/__/     \/__/  




Habla is an assistant that helps you with your software development projects. It scans your codebase and uses AI to answer questions and fulfill requests about it.



## Features



Habla is great for:



- Rapidly understanding how code written by third parties works

- Extending your code considering existing functions and style

- Identifying bugs in integrations and interactions between modules



However, Habla has some limitations:



- It may not work well with very large projects due to its context size limitations imposed by the underlying AI models.

- It may not have knowledge of the latest libraries or packages, as its knowledge has a time cutoff.



## Usage



To use Habla, follow the instructions below:



### Installation



Install Habla with pip:



```shell

pip install git+https://github.com/bryanoliveira/habla --upgrade

```



### API Keys



Set up your favorite model's keys. You have two options:



- Anthropic API key:



```shell

export ANTHROPIC_API_KEY=""

```



- OpenAI API keys:



```shell

export OPENAI_API_KEY=""

export OPENAI_ORG_ID=""

```



### Running Habla



Run Habla from any software development project by executing the following command in your terminal:



```shell

habla

```



Habla will scan your current directory for relevant .py, .js, and other text files and use that context to understand your project.



### Making Requests



Once Habla is running, you can type in requests and it will process them using Anthropic's or OpenAI's API to generate a relevant response based on the context and request.



For example, you can ask:



> Explain the utils.py module



Habla will provide an explanation of the specified module:





This module contains some utility functions:



- typewrite() - Prints a text string character by character with a time delay between each character. This gives a 'typewriter' effect.

- print_divider() - Prints a header text with a divider line under it. The divider line is made of the divider_char repeated to fill the terminal width.  



Some notes:



- It uses the colorama module to print colored text.  

- It uses time.sleep() to create the delay in typewrite().  

- It uses os.get_terminal_size() to get the terminal width and print a divider line that fits the terminal.




## CLI Arguments



| Option                                             | Description                                                                                                             |

| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |

| -h, --help                                         | Show the help message and exit.                                                                                         |

| -p PATH, --path PATH                               | Path to the repository or file (optional, defaults to the current directory).                                           |

| -d MAX_DEPTH, --max-depth MAX_DEPTH                | Maximum depth to scan (optional, defaults to `10`).                                                                     |

| --stream                                           | Stream the assistant response. Disables Markdown rendering.                                                             |

| -t MAX_TOKENS, --max-tokens MAX_TOKENS             | Maximum tokens on the assistant's response (optional, defaults to `2048`).                                              |

| -v {anthropic,openai}, --vendor {anthropic,openai} | The model vendor to use (Anthropic or OpenAI) (optional, defaults to `anthropic`).                                      |

| -m MODEL, --model MODEL                            | The model to use (optional, defaults to `claude-instant-v1-100k`).                                                      |

| --system-message SYSTEM_MESSAGE                    | The system message to start the conversation (optional, defaults to `habla.chat.DEFAULT_SYSTEM_CLAUDE`).                |

| --use-anthropic                                    | Use Anthropic models. Sets `vendor` to `anthropic` and uses the default `system_message` for Claude.                    |

| --use-openai                                       | Use OpenAI models. Sets `vendor` to `openai`, `model` to `gpt-3.5-turbo` and uses the default `system_message` for GPT. |



## Requirements



- Python 3.8+

- An API key from [Anthropic](https://console.anthropic.com) or [OpenAI](https://platform.openai.com) to access their AI models.

- Python libraries installable with `pip install -r requirements.txt`



---



This README was (mostly) generated using `habla` itself!