Developer Workflow: Local Dev, Test, Debug¶

This guide summarizes a practical day-to-day workflow for Edgy projects.

1. Run Docs While Building Features¶

$ hatch run docs:serve

This serves docs with live reload and keeps generated markdown up to date from docs + docs_src.

2. Run Tests¶

$ task test

For a specific test target:

$ hatch run test:test tests/path/to/test_file.py -q

3. Verify Types and Lint¶

$ task lint
$ task mypy

4. Validate Migration State¶

$ edgy check
$ edgy current

5. Debug Common Runtime Issues Quickly¶

If you see lifecycle warnings:

• verify registry/database scope in code (async with registry: or with registry.with_async_env():),
• confirm app discovery settings (--app, EDGY_DEFAULT_APP, or preload setup).

6. Run Benchmark Guardrails for Performance-Sensitive Changes¶

$ pytest tests/benchmarks/ -q

When validating against CodSpeed-compatible behavior:

$ pytest tests/benchmarks/ --codspeed

Workflow Map¶

flowchart LR
    A["Code changes"] --> B["Run tests and type checks"]
    B --> C["edgy check/current"]
    C --> D["Update docs and examples"]
    D --> E["hatch run docs:build"]

See Also¶

• Testing
• Debugging
• Troubleshooting
• Contributing