Metadata-Version: 2.1
Name: codara
Version: 2.0.2
Summary: AI Code Review Automation Tool
Description-Content-Type: text/markdown
Requires-Dist: annotated-types ==0.6.0
Requires-Dist: anyio ==3.7.1
Requires-Dist: blinker ==1.7.0
Requires-Dist: certifi ==2023.11.17
Requires-Dist: cffi ==1.16.0
Requires-Dist: charset-normalizer ==3.3.2
Requires-Dist: click ==8.1.7
Requires-Dist: cryptography ==41.0.7
Requires-Dist: distro ==1.8.0
Requires-Dist: Flask ==3.0.0
Requires-Dist: h11 ==0.14.0
Requires-Dist: httpcore ==1.0.2
Requires-Dist: httpx ==0.25.2
Requires-Dist: idna ==3.6
Requires-Dist: iniconfig ==2.0.0
Requires-Dist: itsdangerous ==2.1.2
Requires-Dist: Jinja2 ==3.1.2
Requires-Dist: MarkupSafe ==2.1.3
Requires-Dist: openai ==1.3.7
Requires-Dist: packaging ==23.2
Requires-Dist: pluggy ==1.3.0
Requires-Dist: pycparser ==2.21
Requires-Dist: pydantic ==2.5.2
Requires-Dist: pydantic-core ==2.14.5
Requires-Dist: PyJWT ==2.8.0
Requires-Dist: pytest ==7.4.3
Requires-Dist: requests ==2.31.0
Requires-Dist: sniffio ==1.3.0
Requires-Dist: tqdm ==4.66.1
Requires-Dist: typing-extensions ==4.8.0
Requires-Dist: urllib3 ==2.1.0
Requires-Dist: Werkzeug ==3.0.1
Requires-Dist: gunicorn ==21.2.0
Requires-Dist: tornado ==6.4

# Codara Code Review and Diagnostics Tool

This script assists in AI code review and diagnosis by using tailored AI models to intelligently provide suggestions and improvements. Purchase a subscription at [codara.io](https://codara.io)

## Features

- Review the code differences between two branches in a Git repository.
- Review unstaged code diffs.
- Generate a formatted review file with a timestamp and the branch commit hash.
- Diagnose code issues directly in the terminal by providing the command to debug.

## Prerequisites

- Python 3.6 or later.
- Git must be installed and configured on the system where the script is executed.

## Installation

```bash
pip install codara
```

## Help and Documentation
```bash
codara --help
```

## Login 
### an active subscription is required to use this tool: [codara.io](https://codara.io)
#### register or login with the below command using the same email used to purchase your subscription
```bash
codara --login
```

## Usage

To use the AI review feature run the following command:

```bash
codara review --unstaged
```
or the short version (shorthands available for all commands)
```bash
codara review -u
```

or review between two branches like a pull request

```bash
codara review --target <target_branch>
```

get help
```bash
codara review --help
```

To use the AI diagnostic feature run the following command:

```bash
codara diagnose "<command-producing-error>"
```
get help
```bash
codara diagnose --help
```

## Output

The AI reviewer will create a new file in the `reviews` directory with the review output. The file will be named using the source and target branch names, their respective commit hashes, and a timestamp.

The AI diagnostics will create a new file in the `diagnostics` directory with the diagnostic output. The file will be named using the command provided and a timestamp.

Example review filename: `feature-branch_abc123_to_main_def456_2023-11-15_23-31-56.txt`

Example diagnostic filename: `diagnose_command_2023-11-15_23-31-56.txt`
