Version 0.2.0 with S3, docker, bells and whistles (#1)

This pull request introduces several updates to enhance the Allocator
Bot's functionality, improve its deployment process, and streamline its
codebase. Key changes include the addition of Docker support, updates to
environment configuration, new GitHub Actions workflows, and significant
refactoring of the bot's agent logic.

### Deployment and Configuration Enhancements:
* Added a `Dockerfile` for multi-stage builds, enabling easy deployment
of the Allocator Bot as a Docker container. The runtime stage uses a
non-root user for security, and the default port is exposed as `4299`.
* Updated `.env.example` to include new configuration options such as S3
storage settings and renamed `API_KEYS_FILE_PATH` to `APP_API_KEY` for
clarity.
* Added `.dockerignore` to exclude unnecessary files from Docker builds,
improving build performance.

### GitHub Actions Workflows:
* Introduced a `docker-publish.yml` workflow to build and publish Docker
images to GitHub Container Registry on pushes to the `main` branch.
* Added a `lint_and_test.yml` workflow to automate linting and testing
on pushes and pull requests to the `main` branch.

### Codebase Refactoring:
* Refactored `allocator_bot/agent.py` to replace OpenAI models with
OpenRouter models, add retry logic, and improve the structure of LLM
interactions. Introduced new helper methods such as `make_llm` and
updated the `execution_loop` to yield reasoning steps and tables for
better SSE responses.
[[1]](diffhunk://#diff-cd2fd1f2d0dc7b64130bc7d15a221de93780ea671fd1022f4a7298d23d6d3151L1-R141)
[[2]](diffhunk://#diff-cd2fd1f2d0dc7b64130bc7d15a221de93780ea671fd1022f4a7298d23d6d3151L153-R181)
* Added logging to `allocator_bot/__main__.py` and implemented a
`get_app` function that loads environment variables and initializes the
FastAPI app.

### Documentation Updates:
* Enhanced `README.md` with Docker setup instructions, environment
variable descriptions, and updated usage details for integration with
OpenBB Workspace.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R3-R14)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L24-R98)
[[3]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L65-R116)

### Miscellaneous:
* Added `.markdownlint.json` to configure markdown linting rules,
disabling `MD033` and `MD013`.
* Updated `.cursorrules`, `CLAUDE.md`, and `GEMINI.md` to include
references to `llms.md`.

Author: piiq

.cursorrules

@@ -0,0 +1 @@
+llms.md

.dockerignore

@@ -0,0 +1,33 @@
+*venv*
+.vscode
+**/*.env
+**/*.pyc
+**/data/**/*
+*.log
+.git
+.gitignore
+.github
+__pycache__
+.pytest_cache
+*.pyc
+*.pyo
+*.pyd
+.coverage
+htmlcov/
+.tox/
+.mypy_cache/
+.DS_Store
+Thumbs.db
+
+LICENSE
+
+tests/
+.codex/
+.claude/
+.gemini/
+.aider/
+llms.md
+CLAUDE.md
+GEMINI.md
+Dockerfile
+.dockerignore

.env.example

@@ -1,11 +1,19 @@
 # Application configuration
 HOST_URL=http://localhost:4322  # The host URL and port number where the app is running.
-API_KEYS_FILE_PATH=api_keys.txt  # The path to the file containing API keys to access the bot.
+APP_API_KEY=my_api_key  # The API key to access the bot.
 DATA_FOLDER_PATH=data  # The path to the folder that will store the allocation data.
 
 # AI configuration
-OPENAI_API_KEY=<your-openai-key>
-MAGENTIC_OPENAI_MAX_TOKENS=4096
-MAGENTIC_OPENAI_TEMPERATURE=0.42
-MAGENTIC_BACKEND=openai
-MAGENTIC_OPENAI_MODEL=gpt-4o
+OPENROUTER_API_KEY=
+
+# S3 configuration
+S3_ENABLED=false  # Set to true to enable S3 storage
+S3_ENDPOINT=  # S3 endpoint URL
+S3_ACCESS_KEY=  # S3 access key
+S3_SECRET_KEY=  # S3 secret key
+S3_BUCKET_NAME=  # S3 bucket name
+ALLOCATION_DATA_FILE=allocations.json  # File name to store allocations
+TASK_DATA_FILE=tasks.json  # File name to store tasks
+
+# Data retrieval configuration
+FMP_API_KEY=

.github/workflows/docker-publish.yml

@@ -0,0 +1,54 @@
+name: Build and Publish Docker Image
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Container Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=sha,prefix={{branch}}-
+            type=raw,value=latest,enable={{is_default_branch}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/lint_and_test.yml

@@ -0,0 +1,35 @@
+name: Run Lints and Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Install dependencies
+        run: uv sync --extra dev
+
+      - name: Run linting
+        run: uv run ruff check .
+
+      - name: Check code formatting
+        run: uv run black --check .
+
+      - name: Run tests
+        run: uv run pytest

.gitignore

@@ -1,7 +1,8 @@
-venv
+*venv*
 .vscode
 **/*.env
 **/*.pyc
 **/data/**/*
 *.log
-*api_keys*.*
+.coverage
+.claude

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+  "MD033": false,
+  "MD013": false
+}

CLAUDE.md

@@ -0,0 +1 @@
+llms.md

Dockerfile

@@ -0,0 +1,33 @@
+# Multi-stage Dockerfile for allocator-bot
+# Build stage
+FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS builder
+ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy
+ENV UV_PYTHON_DOWNLOADS=0
+
+RUN apt-get update && apt-get install -y build-essential git
+
+WORKDIR /app
+COPY . /app
+RUN uv sync --locked --no-dev
+
+# Runtime stage
+FROM python:3.12-slim-bookworm
+WORKDIR /app
+
+# Create non-root user
+RUN groupadd --gid 1000 app && useradd --uid 1000 --gid app --shell /bin/bash --create-home app
+
+# Copy application from builder
+COPY --from=builder --chown=app:app /app /app
+
+# Switch to non-root user
+USER app
+
+# Place executables in PATH
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Expose port
+EXPOSE 4299
+
+# Run the application
+CMD ["openbb-api", "--app", "allocator_bot.__main__:get_app", "--factory", "--host", "0.0.0.0", "--port", "4299"]

GEMINI.md

@@ -0,0 +1 @@
+llms.md