specmaker 0.0.1

SpecMaker is an Multi-Agent documentation system that guides engineers through structured, human-in-the-loop flows to produce high-quality, consistent, and AI-readable specs.

specmaker_core

SpecMaker is an Multi-Agent documentation system that guides engineers through structured, human-in-the-loop flows to produce high-quality, consistent, and AI-readable specs.

Development Setup

After generating your project:

cd specmaker_core

# Install dependencies
uv sync

# Set up environment variables
# Copy .env.example to .env and fill in your values
cp .env.example .env
# Edit .env with your actual configuration (e.g., OpenAI API key)

# Install pre-commit hooks
uv run pre-commit install

# Run tests
uv run pytest

# Run formatting and linting (automatically runs on commit)
uv run ruff format .
uv run ruff check .
# Auto Fix
uv run ruff check . --fix

Docker Development

The template includes a complete Docker setup:

# create uv.lock file
uv sync

# use the provided scripts
./docker/build.sh
./docker/run.sh # or./docker/run.sh (Command)

# Build and run with Docker Compose
docker compose build
docker compose up

VS Code Devcontainer

Open the project in VS Code and use the "Reopen in Container" command for a fully configured development environment.