[Scaffold] Base project structure and configuration #3

Closed
opened 2026-01-01 20:06:41 -06:00 by b3nw · 0 comments
Owner

Overview

Create the foundational project structure following the BLUEPRINT.md pattern.

Tasks

  • Create pyproject.toml with dependencies (fastmcp, aiounifi, starlette, uvicorn, python-dotenv)
  • Create Dockerfile with multi-stage build
  • Create docker-compose.yml with PORT env variable pattern
  • Create .env.example with all configuration variables
  • Create .gitea/workflows/build.yaml CI workflow
  • Create basic README.md

Configuration Variables

Variable Description Default
UNIFI_HOST Controller IP/hostname required
UNIFI_USERNAME Admin username required
UNIFI_PASSWORD Admin password required
UNIFI_PORT HTTPS port 443
UNIFI_SITE Site name default
UNIFI_VERIFY_SSL SSL verification false
UNIFI_ALLOW_WRITES Enable write operations via api_call false

Acceptance Criteria

  • Project can be installed via uv pip install -e .
  • Docker image builds successfully
  • CI workflow syntax is valid
## Overview Create the foundational project structure following the BLUEPRINT.md pattern. ## Tasks - [ ] Create `pyproject.toml` with dependencies (fastmcp, aiounifi, starlette, uvicorn, python-dotenv) - [ ] Create `Dockerfile` with multi-stage build - [ ] Create `docker-compose.yml` with PORT env variable pattern - [ ] Create `.env.example` with all configuration variables - [ ] Create `.gitea/workflows/build.yaml` CI workflow - [ ] Create basic `README.md` ## Configuration Variables | Variable | Description | Default | |----------|-------------|--------| | `UNIFI_HOST` | Controller IP/hostname | required | | `UNIFI_USERNAME` | Admin username | required | | `UNIFI_PASSWORD` | Admin password | required | | `UNIFI_PORT` | HTTPS port | `443` | | `UNIFI_SITE` | Site name | `default` | | `UNIFI_VERIFY_SSL` | SSL verification | `false` | | `UNIFI_ALLOW_WRITES` | Enable write operations via api_call | `false` | ## Acceptance Criteria - Project can be installed via `uv pip install -e .` - Docker image builds successfully - CI workflow syntax is valid
b3nw closed this issue 2026-01-01 20:21:24 -06:00
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: b3nw/unifi-mcp-light#3