@@ -7,16 +7,17 @@ Infrahub Python SDK - async/sync client for Infrahub infrastructure management.
77``` bash
88uv sync --all-groups --all-extras # Install all deps
99uv run invoke format # Format code
10- uv run invoke lint # Lint (ruff + mypy + yamllint)
10+ uv run invoke lint # All linters (code + yamllint + documentation)
11+ uv run invoke lint-code # All linters for Python code
1112uv run pytest tests/unit/ # Unit tests
1213uv run pytest tests/integration/ # Integration tests
1314```
1415
15- ## Tech Stack
16+ ## Tech stack
1617
1718Python 3.10-3.13, UV, pydantic >=2.0, httpx, graphql-core
1819
19- ## Code Pattern
20+ ## Code pattern
2021
2122``` python
2223# Always provide both async and sync versions
@@ -27,7 +28,7 @@ node = await client.get(kind="NetworkDevice")
2728await node.save()
2829```
2930
30- ## Project Structure
31+ ## Project structure
3132
3233``` text
3334infrahub_sdk/
@@ -38,7 +39,7 @@ infrahub_sdk/
3839└── pytest_plugin/ # Custom pytest plugin
3940```
4041
41- ## Markdown Style
42+ ## Markdown style
4243
4344When editing ` .md ` or ` .mdx ` files, run ` uv run invoke lint-docs ` before committing.
4445
@@ -52,7 +53,7 @@ Key rules:
5253
5354✅ ** Always**
5455
55- - Run ` uv run invoke format lint ` before committing Python code
56+ - Run ` uv run invoke format lint-code ` before committing Python code
5657- Run markdownlint before committing markdown changes
5758- Follow async/sync dual pattern for new features
5859- Use type hints on all function signatures
@@ -69,7 +70,7 @@ Key rules:
6970- Modify generated code (protocols.py)
7071- Bypass type checking without justification
7172
72- ## Subdirectory Guides
73+ ## Subdirectory guides
7374
7475- [ docs/AGENTS.md] ( docs/AGENTS.md ) - Documentation (Docusaurus)
7576- [ infrahub_sdk/ctl/AGENTS.md] ( infrahub_sdk/ctl/AGENTS.md ) - CLI development
0 commit comments