docs: add WARP.md for Warp usage (commands, architecture, testing, tooling, containerization) - #5
Open
DanteX86 wants to merge 3 commits into
Open
docs: add WARP.md for Warp usage (commands, architecture, testing, tooling, containerization)#5DanteX86 wants to merge 3 commits into
DanteX86 wants to merge 3 commits into
Conversation
…containerization guidance
DanteX86
changed the title
DanteX86
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds WARP.md to guide Warp (warp.dev) when working in this repository.\n\nWhat’s included\n- Common commands: venv setup, installs (editable), lint/format/type-check/security scan, pytest usage (all/markers/single test), coverage outputs\n- Makefile shortcuts: install, setup, test, lint, format, clean, structure, quick-check, model-info, api, analyze, extract-iocs, generate-report, full-analysis\n- CLI usage: dmv-analyze entry point and module-invocation equivalents\n- API: how to run FastAPI (Makefile or uvicorn), health endpoint\n- Docker/Compose: build/run, mounts (logs/models/data), optional services (Redis, Postgres, Prometheus)\n- Testing details: pytest markers and addopts, example marker selection\n- High-level architecture: CLI, API, core orchestrator/models, analysis modules, dashboard/visualization, utils; data flow and entry points\n- Notes from docs/ARCHITECTURE.md: prefer package-relative imports in CLI subcommands; defer heavy model loads to runtime for API\n\nSources referenced\n- Makefile, pytest.ini, pyproject.toml, .pre-commit-config.yaml\n- Dockerfile, docker-compose.yml, deployment/docker/docker-compose.yml\n- docs/ARCHITECTURE.md and README.md\n\nReviewer checklist\n- [ ] Commands and paths accurate for macOS/Homebrew Python\n- [ ] Architecture summary aligns with src/ layout\n- [ ] Docker guidance mirrors compose services and mounts\n- [ ] No redundant or generic guidance\n\nFollow-ups (optional)\n- Add Make targets for black --check and mypy if desired\n- Consider lazy-loading heavy models in API startup if load-time is noticeable