-
Notifications
You must be signed in to change notification settings - Fork 7
Add AGENTS files #609
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+336
−316
Merged
Add AGENTS files #609
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # AGENTS.md | ||
|
|
||
| Infrahub Python SDK - async/sync client for Infrahub infrastructure management. | ||
|
|
||
| ## Commands | ||
|
|
||
| ```bash | ||
| uv sync --all-groups --all-extras # Install all deps | ||
| uv run invoke format # Format code | ||
| uv run invoke lint # Lint (ruff + mypy + yamllint) | ||
| uv run pytest tests/unit/ # Unit tests | ||
| uv run pytest tests/integration/ # Integration tests | ||
| ``` | ||
|
|
||
| ## Tech Stack | ||
|
|
||
| Python 3.9-3.13, UV, pydantic >=2.0, httpx, graphql-core | ||
|
|
||
| ## Code Pattern | ||
|
|
||
| ```python | ||
| # Always provide both async and sync versions | ||
| client = InfrahubClient() # async | ||
| client = InfrahubClientSync() # sync | ||
|
|
||
| node = await client.get(kind="NetworkDevice") | ||
| await node.save() | ||
| ``` | ||
|
|
||
| ## Project Structure | ||
|
|
||
| ```text | ||
| infrahub_sdk/ | ||
| ├── client.py # Main client implementations | ||
| ├── config.py # Pydantic configuration | ||
| ├── node/ # Node system (core data model) | ||
| ├── ctl/ # CLI (infrahubctl) | ||
| └── pytest_plugin/ # Custom pytest plugin | ||
| ``` | ||
|
|
||
| ## Markdown Style | ||
|
|
||
| When editing `.md` files, run `uv run invoke lint-docs` before committing. | ||
|
||
|
|
||
| Key rules: | ||
|
|
||
| - Use `text` language for directory structure code blocks | ||
| - Add blank lines before and after lists | ||
| - Always specify language in fenced code blocks (`python`, `bash`, `text`) | ||
|
|
||
| ## Boundaries | ||
|
|
||
| ✅ **Always** | ||
|
|
||
| - Run `uv run invoke format lint` before committing Python code | ||
| - Run markdownlint before committing markdown changes | ||
| - Follow async/sync dual pattern for new features | ||
| - Use type hints on all function signatures | ||
|
|
||
| ⚠️ **Ask first** | ||
|
|
||
| - Adding new dependencies | ||
| - Changing public API signatures | ||
|
|
||
| 🚫 **Never** | ||
|
|
||
| - Push to GitHub automatically (always wait for user approval) | ||
| - Mix async/sync inappropriately | ||
| - Modify generated code (protocols.py) | ||
| - Bypass type checking without justification | ||
|
|
||
| ## Subdirectory Guides | ||
|
|
||
| - [docs/AGENTS.md](docs/AGENTS.md) - Documentation (Docusaurus) | ||
| - [infrahub_sdk/ctl/AGENTS.md](infrahub_sdk/ctl/AGENTS.md) - CLI development | ||
| - [infrahub_sdk/pytest_plugin/AGENTS.md](infrahub_sdk/pytest_plugin/AGENTS.md) - Pytest plugin | ||
| - [tests/AGENTS.md](tests/AGENTS.md) - Testing | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think we're minimum python 3.10 now?