@@ -7,16 +7,16 @@ 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 )
1111uv run pytest tests/unit/ # Unit tests
1212uv run pytest tests/integration/ # Integration tests
1313```
1414
15- ## Tech Stack
15+ ## Tech stack
1616
1717Python 3.10-3.13, UV, pydantic >=2.0, httpx, graphql-core
1818
19- ## Code Pattern
19+ ## Code pattern
2020
2121``` python
2222# Always provide both async and sync versions
@@ -27,7 +27,7 @@ node = await client.get(kind="NetworkDevice")
2727await node.save()
2828```
2929
30- ## Project Structure
30+ ## Project structure
3131
3232``` text
3333infrahub_sdk/
@@ -38,7 +38,7 @@ infrahub_sdk/
3838└── pytest_plugin/ # Custom pytest plugin
3939```
4040
41- ## Markdown Style
41+ ## Markdown style
4242
4343When editing ` .md ` or ` .mdx ` files, run ` uv run invoke lint-docs ` before committing.
4444
@@ -52,7 +52,7 @@ Key rules:
5252
5353✅ ** Always**
5454
55- - Run ` uv run invoke format lint ` before committing Python code
55+ - Run ` uv run invoke format lint-code ` before committing Python code
5656- Run markdownlint before committing markdown changes
5757- Follow async/sync dual pattern for new features
5858- Use type hints on all function signatures
@@ -69,7 +69,7 @@ Key rules:
6969- Modify generated code (protocols.py)
7070- Bypass type checking without justification
7171
72- ## Subdirectory Guides
72+ ## Subdirectory guides
7373
7474- [ docs/AGENTS.md] ( docs/AGENTS.md ) - Documentation (Docusaurus)
7575- [ infrahub_sdk/ctl/AGENTS.md] ( infrahub_sdk/ctl/AGENTS.md ) - CLI development
0 commit comments