Adds missing standard artifacts: - README.md (if missing) - AGENTS.md (AI agent contract) - PLAN.md (current sprint) - STATUS.md (where we are) - DEVELOPMENT.md (dev workflow) - DEPLOYMENT.md (deploy procedure) - TESTING.md (test strategy) - DECISIONS.md (ADR index + templates) - .github/CODEOWNERS - .github/workflows/ci.yml Preserves all existing artifacts. Refs: RugMunchMedia/fleet-template
2.5 KiB
2.5 KiB
AGENTS.md — PryScraper
AI agent contract. Read this before touching anything in this repo.
Status
canonical · owner=crmuncher · last_updated=2026-07-02
What This Repo Is
Multi-source crypto intelligence crawler (munchcrawl). Scraper, extractor, parser, automator, job queue. CLI + MCP server + SDK.
Type
backend · language=Python 3.12 + FastAPI
Where It Lives
- Source:
https://git.rugmunch.io/RugMunchMedia/pryscraper - Deployed: Docker on Talos (/srv/pry/)
- Port: 8005
Built With
- Standards: git.rugmunch.io/RugMunchMedia/standards
- Toolchain: TOOLCHAIN.md
- Conventions: CONVENTIONS.md
Components
/srv/pry/*.py: 83 Python modules (api.py, extractor.py, parser.py, etc.)browser-extension/: Chrome/Firefox extension
Dependencies
- postgresql (job storage)
- redis (cache)
- flaresolverr (Cloudflare bypass, on Hydra)
- playwright (browser automation)
🚨 CRITICAL RULES
- No nested repos. Don't commit other complete project trees inside this one.
- No secrets. Never commit
.secrets/,.env,*.pem,*.key,*.crt. Use gopass. - No data blobs. Don't commit
*.zip,*.parquet, model weights, sqlite files. - No broken files. Shell heredoc accidents must be caught before commit.
- No duplicate scaffolds. If a
backend/orfrontend/subdir exists at root, it's either THE app or bloat. - Update STATUS.md before committing. Builders must know where we are.
- Read DECISIONS.md before architectural changes. Don't repeat rejected designs.
Commands
make install # install deps
make dev # dev server
make test # tests
make lint # ruff + format check
make typecheck # mypy strict
make security # bandit + gitleaks
make ci # full pipeline
make commit # conventional commit
make clean # remove build artifacts
Architecture
See ARCHITECTURE.md. Update it when components change.
Plan
PLAN.md shows current sprint. Update weekly.
Status
STATUS.md shows where we are RIGHT NOW. Update before each commit.
Owners
- Primary: crmuncher
- Backup: TBD