Skip to content

MVP_HANDOFF.md

Latest commit

 

History

History
68 lines (55 loc) · 2.35 KB

MVP_HANDOFF.md

File metadata and controls

68 lines (55 loc) · 2.35 KB

MVP Handoff

This document summarizes the current read-only MVP state for review, PR preparation and the next engineering pass.

Implemented scope

  • Read-only CS2 market monitor with Typer CLI and Docker runtime.
  • Demo mode for safe local validation without external marketplace calls.
  • Real mode with Steam baseline and CSFloat adapter profile.
  • Domain models for money, fees, prices, liquidity and opportunities.
  • ROI/risk/liquidity scoring with Decimal money calculations.
  • Telegram-ready alerting with sent-signal deduplication.
  • SQLite persistence with schema migrations.
  • Persisted scan run metrics and recent run inspection.
  • Marketplace health/cooldown persistence and reset command.
  • Safe storage commands: stats, runs, cleanup, backup, restore and maintenance.
  • Restore safety: --confirm, SQLite integrity check, Steam-Pulse schema check and automatic pre-restore backup.
  • Worker graceful shutdown for local and Docker operation.
  • Operator runbook for checks, maintenance, restore and incident triage.
  • GitHub Actions CI for tests, lint, type checks, dependency audit and compose validation.

Validation status

Last validated checks:

python -m pytest
python -m ruff check .
python -m mypy src
python -m pip check
python -m pip_audit
docker compose config --quiet

Safe CLI smoke was run against a temporary SQLite database:

steam-pulse doctor --offline
steam-pulse scan --demo
steam-pulse storage stats
steam-pulse storage runs --limit 5
steam-pulse storage maintenance --dry-run --json

Suggested PR summary

## Summary
- Built the read-only Steam-Pulse MVP with Docker, Typer CLI, SQLite persistence, marketplace adapters and alerting.
- Added operator-grade storage workflows: scan runs, stats, retention cleanup, backup, restore and maintenance.
- Hardened runtime behavior with safe HTTP/logging, marketplace health/cooldown state and graceful worker shutdown.
- Added deployment, security and operations documentation.

## Validation
- pytest
- ruff check .
- mypy src
- pip check
- pip_audit
- docker compose config --quiet
- safe CLI smoke on a temporary SQLite database

Remaining work

  • Add structured metrics beyond current CLI/storage observability.
  • Add more real marketplace adapters and contract fixtures.
  • Keep controlled trading research out of the MVP until read-only operations are stable.