https://github.com/defra/ai-sdlc-codereview-api
Git repository for service ai-sdlc-codereview-api
https://github.com/defra/ai-sdlc-codereview-api
backend cdp node service
Last synced: 4 months ago
JSON representation
Git repository for service ai-sdlc-codereview-api
- Host: GitHub
- URL: https://github.com/defra/ai-sdlc-codereview-api
- Owner: DEFRA
- License: other
- Created: 2025-02-17T16:06:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T13:53:41.000Z (over 1 year ago)
- Last Synced: 2025-07-12T18:00:25.873Z (12 months ago)
- Topics: backend, cdp, node, service
- Language: Python
- Size: 383 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ai-sdlc-codereview-api
A Python FastAPI service that provides endpoints for creating and retrieving AI-powered code reviews, with asynchronous analysis using Anthropic's API.
- [ai-sdlc-codereview-api](#ai-sdlc-codereview-api)
- [Requirements](#requirements)
- [Python](#python)
- [Docker](#docker)
- [Local development](#local-development)
- [Setup & Configuration](#setup--configuration)
- [Development](#development)
- [Testing](#testing)
- [Production Mode](#production-mode)
- [API endpoints](#api-endpoints)
- [Custom Cloudwatch Metrics](#custom-cloudwatch-metrics)
- [Pipelines](#pipelines)
- [Dependabot](#dependabot)
- [SonarCloud](#sonarcloud)
- [Licence](#licence)
- [About the licence](#about-the-licence)
## Requirements
### Python
Please install python `>= 3.12` and [configure your python virtual environment](https://fastapi.tiangolo.com/virtual-environments/#create-a-virtual-environment):
```python
# create the virtual environment
python -m venv .venv
# activate the the virtual environment in the command line
source .venv/bin/activate
# update pip
python -m pip install --upgrade pip
# install the dependencies
pip install -r requirements-dev.txt
```
This service uses the [`Fast API`](https://fastapi.tiangolo.com/) Python API framework with MongoDB for data storage and Anthropic's Claude for AI-powered code analysis.
This and all other runtime python libraries must reside in `requirements.txt`
Other non-runtime dependencies used for dev & test must reside in `requirements-dev.txt`
### Docker
This repository uses Docker throughput its lifecycle i.e. both for local development and the environments. A benefit of this is that environment variables & secrets are managed consistently throughout the lifecycle
See the `Dockerfile` and `compose.yml` for details
## Local development
### Setup & Configuration
Follow the convention below for local environment variables and secrets in local development. Note that it does not use .env or python-dotenv as this is not the convention in the CDP environment.
**Environment variables:** `compose/aws.env`.
**Secrets:** `compose/secrets.env`. You need to create this, as it's excluded from version control. Required secrets include:
- `ANTHROPIC_API_KEY`: If using standard Anthropic, not bedrock
- `MONGO_URI`: MongoDB connection string (if different from default)
**Libraries:** Ensure the python virtual environment is configured and libraries are installed using `requirements-dev.txt`, [as above](#python)
### Development
The app can be run locally using Docker compose. This template contains a local environment with:
- Localstack
- MongoDB
- This service
To run the application in development mode:
```bash
docker compose watch
```
### Testing
Ensure the python virtual environment is configured and libraries are installed using `requirements-dev.txt`, [as above](#python)
Testing follows the [FastApi documented approach](https://fastapi.tiangolo.com/tutorial/testing/); using pytest & starlette.
To test the application run:
```bash
pytest
```
### Production Mode
To mimic the application running in `production mode locally run:
```bash
docker compose up --build -d
```
Stop the application with
```bash
docker compose down
```
## API endpoints
| Endpoint | Description |
| :------------------------- | :----------------------------- |
| `GET: /docs` | Automatic API Swagger docs |
| `GET: /health` | Health check endpoint |
| `GET: /api/v1/code-reviews` | List all code reviews |
| `POST: /api/v1/code-reviews` | Create new code review |
| `GET: /api/v1/code-reviews/{id}` | Get specific review |
| `GET: /api/v1/code-reviews/{id}/results`| Get review results |
## Custom Cloudwatch Metrics
Uses the [aws embedded metrics library](https://github.com/awslabs/aws-embedded-metrics-python). An example can be found in `metrics.py`
In order to make this library work in the environments, the environment variable `AWS_EMF_ENVIRONMENT=local` is set in the app config. This tells the library to use the local cloudwatch agent that has been configured in CDP, and uses the environment variables set up in CDP `AWS_EMF_AGENT_ENDPOINT`, `AWS_EMF_LOG_GROUP_NAME`, `AWS_EMF_LOG_STREAM_NAME`, `AWS_EMF_NAMESPACE`, `AWS_EMF_SERVICE_NAME`
## Pipelines
### Dependabot
We have added an example dependabot configuration file to the repository. You can enable it by renaming
the [.github/example.dependabot.yml](.github/example.dependabot.yml) to `.github/dependabot.yml`
### SonarCloud
Instructions for setting up SonarCloud can be found in [sonar-project.properties](./sonar-project.properties)
## Licence
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
The following attribution statement MUST be cited in your products and applications when using this information.
> Contains public sector information licensed under the Open Government license v3
### About the licence
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable
information providers in the public sector to license the use and re-use of their information under a common open
licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.