Weni CLI Backend

FastAPI backend service for Weni CLI.

Features

• FastAPI-based REST API
• Poetry for dependency management
• Type hints and validation with Pydantic
• Structured project layout
• Configuration management with environment variables
• Linting with Ruff and Mypy

Prerequisites

• Python 3.12 or higher
• Poetry

Setup

1. Clone the repository:

git clone https://github.com/weni-ai/weni-cli-backend.git
cd weni-cli-backend

2. Install dependencies with Poetry:

poetry install

3. Create a .env file based on the example:

cp .env.example .env

4. Configure environment variables in the .env file.

Development

Running the server for development

# Using poetry
poetry run uvicorn app.main:app --reload --host=0.0.0.0 --port=8000

# Or activate the virtual environment first
poetry shell
python -m app.server

The API will be available at http://localhost:8000.

Testing

Running tests

poetry run pytest

Linting

# Run ruff linter
poetry run ruff check .

# Run mypy type checker
poetry run mypy .

Docker

Using Docker Compose

The project includes Docker configuration for both development and production environments.

Development Environment

Run the application with hot reload for development:

docker-compose up api-dev

The API will be available at http://localhost:8001.

Production Environment

Run the application in production mode:

docker-compose up api

The API will be available at http://localhost:8000.

Building Docker Images

Build the production image:

docker build -t weni-cli-backend:latest -f docker/Dockerfile .

Build the development image:

docker build -t weni-cli-backend:dev -f docker/Dockerfile.dev .

Running Docker Containers Directly

Run the production container:

docker run -p 8000:8000 --env-file .env weni-cli-backend:latest

Run the development container with mounted volume for hot reload:

docker run -p 8000:8000 -v $(pwd):/app --env-file .env weni-cli-backend:dev