Add Guardrails API endpoints, validator configs and test infrastructure #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

rkritika1508 merged 42 commits into main from dev-0.1

Jan 15, 2026

.env.example

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+    DOMAIN=localhost
+    ENVIRONMENT=development
+    PROJECT_NAME="Kaapi-Guardrails"
+    STACK_NAME=Kaapi-Guardrails
+    # API Base URL for cron scripts (defaults to http://localhost:8000 if not set)
+    API_BASE_URL=http://localhost:8000
+    # Postgres
+    POSTGRES_SERVER=localhost
+    POSTGRES_PORT=5432
+    POSTGRES_DB=kaapi-guardrails
+    POSTGRES_USER=postgres
+    POSTGRES_PASSWORD=postgres
+    SENTRY_DSN=
+    # Configure these with your own Docker registry images
+    DOCKER_IMAGE_BACKEND=kaapi-guardrails-backend
+    # Callback Timeouts (in seconds)
+    CALLBACK_CONNECT_TIMEOUT=3
+    CALLBACK_READ_TIMEOUT=10
+    # require as a env if you want to use doc transformation
+    OPENAI_API_KEY="<ADD-KEY>"
+    GUARDRAILS_HUB_API_KEY="<ADD-KEY>"
+    AUTH_TOKEN="<ADD-TOKEN>"

.env.test

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+    DOMAIN=localhost
+    ENVIRONMENT=testing
+    PROJECT_NAME="Kaapi-Guardrails"
+    STACK_NAME=Kaapi-Guardrails
+    # API Base URL for cron scripts (defaults to http://localhost:8000 if not set)
+    API_BASE_URL=http://localhost:8000
+    # Postgres
+    POSTGRES_SERVER=localhost
+    POSTGRES_PORT=5432
+    POSTGRES_DB=kaapi-guardrails
+    POSTGRES_USER=postgres
+    POSTGRES_PASSWORD=postgres
+    SENTRY_DSN=
+    # Configure these with your own Docker registry images
+    DOCKER_IMAGE_BACKEND=kaapi-guardrails-backend
+    # Callback Timeouts (in seconds)
+    CALLBACK_CONNECT_TIMEOUT=3
+    CALLBACK_READ_TIMEOUT=10
+    # require as a env if you want to use doc transformation
+    OPENAI_API_KEY="<ADD-KEY>"
+    GUARDRAILS_HUB_API_KEY="<ADD-KEY>"
+    AUTH_TOKEN="<ADD-TOKEN>"

.env.test.example

-Original file line number
+Diff line change
@@ -0,0 +1,31 @@
+    DOMAIN=localhost
+    ENVIRONMENT=testing
+    PROJECT_NAME="Kaapi-Guardrails"
+    STACK_NAME=Kaapi-Guardrails
+    # API Base URL for cron scripts (defaults to http://localhost:8000 if not set)
+    API_BASE_URL=http://localhost:8000
+    # Postgres
+    POSTGRES_SERVER=localhost
+    POSTGRES_PORT=5432
+    POSTGRES_DB=kaapi-guardrails
+    POSTGRES_USER=postgres
+    POSTGRES_PASSWORD=postgres
+    SENTRY_DSN=
+    # Configure these with your own Docker registry images
+    DOCKER_IMAGE_BACKEND=kaapi-guardrails-backend
+    # Callback Timeouts (in seconds)
+    CALLBACK_CONNECT_TIMEOUT=3
+    CALLBACK_READ_TIMEOUT=10
+    # require as a env if you want to use doc transformation
+    OPENAI_API_KEY="<ADD-KEY>"
+    GUARDRAILS_HUB_API_KEY="<ADD-KEY>"
+    AUTH_TOKEN="<ADD-TOKEN>"

.gitignore

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    __pycache__
+    app.egg-info
+    *.pyc
+    .mypy_cache
+    .coverage
+    htmlcov
+    .cache
+    .venv
+    .DS_Store
+    .env
+    .env.test

README.md

-Original file line number
+Diff line change
@@ -1,2 +1,84 @@
     # kaapi-guardrails
     A repo for our experiments with Guardrails so can be integrated with Kaapi
+    # Kaapi Guardrails
+    [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+    ![](https://github.com/ProjectTech4DevAI/ai-platform/workflows/Continuous%20Integration/badge.svg)
+    ![GitHub issues](https://img.shields.io/github/issues-raw/ProjectTech4DevAI/kaapi-guardrails)
+    [![Commits](https://img.shields.io/github/commit-activity/m/ProjectTech4DevAI/kaapi-guardrails)](https://img.shields.io/github/commit-activity/m/ProjectTech4DevAI/kaapi-guardrails)
+    ## Pre-requisites
+    - [docker](https://docs.docker.com/get-started/get-docker/) Docker
+    - [uv](https://docs.astral.sh/uv/) for Python package and environment management.
+    ## Project Setup
+    You can **just fork or clone** this repository and use it as is.
+    ✨ It just works. ✨
+    ### Configure
+    Create env file using example file
+    ```bash
+    cp .env.example .env
+    ```
+    You can then update configs in the `.env` files to customize your configurations.
+    ⚠️ Some services depend on these environment variables being set correctly. Missing or invalid values may cause startup issues.
+    ## Bootstrap & development mode
+    You have two options to start this dockerized setup, depending on whether you want to reset the database:
+    ### Option A: Run migrations & seed data (will reset DB)
+    Use the prestart profile to automatically run database migrations and seed data.
+    This profile also resets the database, so use it only when you want a fresh start.
+    ```bash
+    docker compose --profile prestart up
+    ```
+    ### Option B: Start normally without resetting DB
+    If you don't want to reset the database, start the project directly:
+    ```bash
+    docker compose watch
+    ```
+    This will start all services in watch mode for development — ideal for local iterations.
+    ### Rebuilding Images
+    ```bash
+    docker compose up --build -d
+    ```
+    This is also necessary when:
+    - Dependencies change in `pyproject.toml` or `uv.lock`
+    - You modify Dockerfile configurations
+    - Changes aren't being reflected in the running containers
+    ## Backend Development
+    Backend docs: [backend/README.md](./backend/README.md).
+    ## Deployment
+    Deployment docs: [deployment.md](./deployment.md).
+    ## Development
+    General development docs: [development.md](./development.md).
+    This includes using Docker Compose, custom local domains, `.env` configurations, etc.
+    ## Release Notes
+    Check the file [release-notes.md](./release-notes.md).
+    ## Credits
+    This project was created using [full-stack-fastapi-template](https://github.com/fastapi/full-stack-fastapi-template). A big thank you to the team for creating and maintaining the template!!!

backend/Dockerfile

-Original file line number
+Diff line change
@@ -0,0 +1,49 @@
+    FROM python:3.10
+    ENV PYTHONUNBUFFERED=1
+    WORKDIR /app/
+    # Install uv
+    # Ref: https://docs.astral.sh/uv/guides/integration/docker/#installing-uv
+    COPY --from=ghcr.io/astral-sh/uv:0.5.11 /uv /uvx /bin/
+    # Place executables in the environment at the front of the path
+    # Ref: https://docs.astral.sh/uv/guides/integration/docker/#using-the-environment
+    ENV PATH="/app/.venv/bin:$PATH"
+    # Compile bytecode
+    # Ref: https://docs.astral.sh/uv/guides/integration/docker/#compiling-bytecode
+    ENV UV_COMPILE_BYTECODE=1
+    # uv Cache
+    # Ref: https://docs.astral.sh/uv/guides/integration/docker/#caching
+    ENV UV_LINK_MODE=copy
+    # Install dependencies
+    # Ref: https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layers
+    RUN --mount=type=cache,target=/root/.cache/uv \
+        --mount=type=bind,source=uv.lock,target=uv.lock \
+        --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+        uv sync --frozen --no-install-project
+    ENV PYTHONPATH=/app
+    RUN apt-get update && apt-get install -y jq && rm -rf /var/lib/apt/lists/*
+    COPY ./scripts /app/scripts
+    RUN chmod +x /app/scripts/*.sh
+    COPY ./pyproject.toml ./uv.lock ./alembic.ini /app/
+    COPY ./app /app/app
+    COPY ./tests /app/tests
+    # Sync the project
+    # Ref: https://docs.astral.sh/uv/guides/integration/docker/#intermediate-layers
+    RUN --mount=type=cache,target=/root/.cache/uv \
+        uv sync
+    # -------------------------------
+    # Entrypoint (runtime setup)
+    # -------------------------------
+    ENTRYPOINT ["/app/scripts/entrypoint.sh"]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Guardrails API endpoints, validator configs and test infrastructure #11

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!