From 6888e6af6061c96d61461d0450d124da2a5bc364 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <209825114+claude[bot]@users.noreply.github.com> Date: Thu, 31 Jul 2025 12:37:11 +0000 Subject: [PATCH] docs: add CLAUDE.md with mypy permissions and setup instructions Documents the mypy type checking setup and required permissions for Claude to run type checking commands. Co-authored-by: Yusuf Ali --- CLAUDE.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..223397f --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,28 @@ +# Claude Development Instructions + +## Type Checking with mypy + +### Setup +This project uses mypy for static type checking. The mypy dependency is included in `requirements-dev.txt`. + +### Required Commands +To enable full type checking capabilities, Claude needs permission to run: +- `mypy servc --check-untyped-defs` - Run type checking on the servc package with untyped function checking +- `pip install -r requirements-dev.txt` - Install development dependencies including mypy +- `python -m pip install -r requirements-dev.txt` - Alternative pip installation method + +### mypy Configuration +The project includes type stubs and typing information: +- `servc/py.typed` - Marks the package as type-aware +- Type stubs for dependencies are included in requirements-dev.txt + +### Development Workflow +1. Install development dependencies: `pip install -r requirements-dev.txt` +2. Run type checking: `mypy servc --check-untyped-defs` +3. Fix any type issues before committing + +## Permissions +Claude requires the following Bash tool permissions: +- `pip` commands for dependency installation +- `python` commands for running type checkers +- `mypy` commands for static type analysis \ No newline at end of file