Codedog reviews your pull request using llm.
Project description
🐶 Codedog
Review your Github/Gitlab PR with ChatGPT
Configuration
Codedog currently load config from environment variables.
settings:
| Config Name | Required | Default | Description |
|---|---|---|---|
| CODEDOG_SERVER | No | 0.0.0.0 | Server address |
| CODEDOG_PORT | No | 32167 | Server port |
| CODEDOG_WORKER_NUM | No | 1 | Server thread number |
| OPENAI_API_KEY | Yes | Api Key for calling openai gpt4 api | |
| OPENAI_PROXY | No | Openai proxy | |
| AZURE_OPENAI | No | Use azure openai gpt 3.5 if not blank | |
| AZURE_OPENAI_API_KEY | No | Azure openai api key | |
| AZURE_OPENAI_API_BASE | No | Azure openai api base | |
| AZURE_OPENAI_DEPLOYMENT_ID | No | Azure openai deployment id for gpt 3.5 | |
| AZURE_OPENAI_EMBEDDING_DEP_ID | No | Azure openai deployment id for embedding | |
| GITHUB_TOKEN | No | Retrieve github pr data and comment |
Usage
Github Example with GPT4
check example/github_review.py
server
We have a demo server for you to try.
-
Run server with:
poetry install --with http poetry run demoserver
Development
poetry install --with dev, test, http
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
codedog-0.5.0.tar.gz
(21.1 kB
view details)
Built Distribution
codedog-0.5.0-py3-none-any.whl
(32.2 kB
view details)
File details
Details for the file codedog-0.5.0.tar.gz.
File metadata
- Download URL: codedog-0.5.0.tar.gz
- Upload date:
- Size: 21.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.10.9 Darwin/22.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2801cd38418ebbc560ba3482ac0fb5c08415f1d3919a66992dbfa01640131269 |
|
| MD5 | 498a2e7030812feaa90c703f03966fed |
|
| BLAKE2b-256 | b158c257747f278dbee481dbffdb2228f085f414758db2d9521967b2f8b1dad8 |
Provenance
File details
Details for the file codedog-0.5.0-py3-none-any.whl.
File metadata
- Download URL: codedog-0.5.0-py3-none-any.whl
- Upload date:
- Size: 32.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.5.1 CPython/3.10.9 Darwin/22.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5fba128d5f5a12f93f287fcee620ecd5b8cadafe1bc843142a353da60938e9e4 |
|
| MD5 | 37bc2e85bf1bf0406e87c73f7662026e |
|
| BLAKE2b-256 | 8c8fdbf0bce8323c5b6ccb0df23a561c0179d34ed4ca7b65b6bee8d7f3acb343 |
