Metadata-Version: 2.1
Name: code-qa
Version: 0.2.0
Summary: 
Author: Steven Mi
Author-email: steven.mi@getyourguide.com
Requires-Python: >=3.8.1,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: chromadb (>=0.3.25,<0.4.0)
Requires-Dist: fire (>=0.5.0,<0.6.0)
Requires-Dist: langchain (>=0.0.187,<0.0.188)
Requires-Dist: openai (>=0.27.7,<0.28.0)
Requires-Dist: pathspec (>=0.11.1,<0.12.0)
Requires-Dist: tiktoken (>=0.4.0,<0.5.0)
Description-Content-Type: text/markdown

# CodeQA

CodeQA is a command-line tool that allows you to ask questions about a project. Gain insights and deepen your
understanding of a repository's codebase effortlessly. It is built on top of LangChain.

## Getting Started

Install Code QA:

```bash
pip install code-qa
```

Add your OpenAI token as virtual environment:

```bash
export OPENAI_TOKEN=YOUR_TOKEN
```

Go to your project folder:

```bash
cd PATH/TO/MY/PROJECT
```

Initialise Code QA Index. This will generate an `code_qa` folder within your project:

```
code_qa init
```

Ask questions about my code:

```
code_qa query How can I test this
```

## Ignoring Files

If you want to ignore certain files, then create an `.codeqaignore` file and specify them. The file follows the same
standard as `.gitignore`

## License
Apache License Version 2.0, see `LICENSE`
