docs/docs/python-sdk/guides/client.mdx (3)

61-79: Fix Tabs: only one TabItem should be default and remove incorrect awaits in async token examples

• Docusaurus Tabs allow a single default per group; currently both Async and Sync have default.
• The client constructor should not be awaited; use await on client methods instead.

Apply this diff:

   <TabItem value="Async" default>
@@
-  from infrahub_sdk import Config, InfrahubClient
-  client = await InfrahubClient(config=Config(api_token="token"))
-  client = await InfrahubClient() # token is read from the INFRAHUB_API_TOKEN environment variable
+  from infrahub_sdk import Config, InfrahubClient
+  client = InfrahubClient(config=Config(api_token="token"))
+  client = InfrahubClient()  # token is read from the INFRAHUB_API_TOKEN environment variable
@@
-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

86-104: JWT examples: remove awaits and fix wording to “environment variables” and “credentials”

• Constructors shouldn’t be awaited.
• For username/password, refer to “credentials” and pluralize “variables.”

Apply this diff:

   <TabItem value="Async" default>
@@
-  from infrahub_sdk import Config, InfrahubClient
-  client = await InfrahubClient(config=Config(username="admin", password="infrahub"))
-  client = await InfrahubClient() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  from infrahub_sdk import Config, InfrahubClient
+  client = InfrahubClient(config=Config(username="admin", password="infrahub"))
+  client = InfrahubClient()  # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables
@@
-  <TabItem value="Sync" default>
+  <TabItem value="Sync">
@@
-  client = InfrahubClientSync(config=Config(username="admin", password="infrahub"))
-  client = InfrahubClientSync() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClientSync(config=Config(username="admin", password="infrahub"))
+  client = InfrahubClientSync()  # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

---

115-133: Tabs default duplication and unnecessary await in GraphQL debugging example

• Keep only one default TabItem.
• Do not await the client constructor.

Apply this diff:

   <TabItem value="Async" default>
@@
-  config = Config(echo_graphql_queries=True)
-  client = await InfrahubClient(config=config)
+  config = Config(echo_graphql_queries=True)
+  client = InfrahubClient(config=config)
@@
-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

docs/docs/python-sdk/guides/client.mdx (4)

7-7: Remove duplicate H1; frontmatter title already renders as page title

The explicit H1 duplicates the frontmatter title and will render two titles.

Apply this diff:

-# How to create and configure an Infrahub client

---

141-142: Use “configuration” instead of “config” to satisfy Vale style

This addresses the Vale error about preferring “configuration” over “config.”

Apply this diff:

-Use `INFRAHUB_PROXY` environment variable or the `proxy` config parameter to set a single proxy for all HTTP and HTTPS requests:
+Use the `INFRAHUB_PROXY` environment variable or the `proxy` configuration option to set a single proxy for all HTTP and HTTPS requests:

---

242-284: Validation snippets: remove unused imports and duplicate default on Sync TabItem

• Clean up unused Config imports in both Async/Sync blocks.
• Only one TabItem should be default.

Apply this diff:

-  <TabItem value="Async" default>
+  <TabItem value="Async" default>
@@
-  from infrahub_sdk import InfrahubClient, Config
+  from infrahub_sdk import InfrahubClient
@@
-  <TabItem value="Sync" default>
+  <TabItem value="Sync">
@@
-  from infrahub_sdk import InfrahubClientSync, Config
+  from infrahub_sdk import InfrahubClientSync

---

139-170: Optional: adjust heading to satisfy Vale’s sentence-case rule if it still flags

Vale warned about sentence case for “Separate proxies for HTTP and HTTPS.” If the warning persists, rephrase to an imperative heading which often passes stricter rules.

Apply this diff:

-### Separate proxies for HTTP and HTTPS
+### Use separate proxies for HTTP and HTTPS

CLAUDE.md (3)

82-87: Tone down “CRITICAL” note; keep it directive but less shouty

Reduce intensity while preserving the directive, which also tends to play nicer with doc style linters.

Apply this diff:

-# CRITICAL: Use validate() method, NOT check()
+# Important: Use validate() (not check())
 class MyCheck(InfrahubCheck):
-    def validate(self, data):  # Must be validate(), not check()
+    def validate(self, data):  # Must be validate(), not check()
         # validation logic
         pass

---

161-166: Avoid pinning tool versions in prose; reference the config instead

Ruff’s version evolves; pointing to pyproject avoids drift between docs and code.

Apply this diff:

-- **Ruff**: Comprehensive linting and formatting (0.11.0)
+- **Ruff**: Comprehensive linting and formatting (as configured in pyproject.toml)

---

139-156: Nice contributor ops section; consider linking from CONTRIBUTING.md

This is a helpful guide. Add a link from CONTRIBUTING.md (or create one if missing) so contributors can discover it.

I can open a follow-up PR wiring this into CONTRIBUTING and the docs sidebar if you want.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

docs/docs/python-sdk/guides/client.mdx (3)

65-67: Async examples: remove await on InfrahubClient constructor

Constructors aren’t awaitable. Only async client methods (e.g., get) should be awaited.

Apply these changes:

-  client = await InfrahubClient(config=Config(api_token="token"))
-  client = await InfrahubClient() # token is read from the INFRAHUB_API_TOKEN environment variable
+  client = InfrahubClient(config=Config(api_token="token"))
+  client = InfrahubClient() # token is read from the INFRAHUB_API_TOKEN environment variable
@@
-  client = await InfrahubClient(config=Config(username="admin", password="infrahub"))
-  client = await InfrahubClient() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClient(config=Config(username="admin", password="infrahub"))
+  client = InfrahubClient() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables
@@
-  client = await InfrahubClient(config=config)
+  client = InfrahubClient(config=config)
@@
-  client = await InfrahubClient(config=config)
+  client = InfrahubClient(config=config)
@@
-  # export INFRAHUB_PROXY=http://proxy.example.com:8080
-  client = await InfrahubClient()
+  # export INFRAHUB_PROXY=http://proxy.example.com:8080
+  client = InfrahubClient()
@@
-  # Proxy configuration is read from environment variables
-  client = await InfrahubClient()
+  # Proxy configuration is read from environment variables
+  client = InfrahubClient()

Also applies to: 90-92, 120-120, 149-149, 153-153, 187-187

---

70-70: Tabs: remove duplicate default attribute from Sync tabs

Only one TabItem per Tabs group should be default. Keep Async as default and remove from Sync.

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

Also applies to: 95-95, 124-124, 157-157, 223-223, 263-263

---

172-201: Proxy mounts: add programmatic example and fix async constructor usage

Provide a Config-based example for separate HTTP/HTTPS proxies alongside the env-var option, and do not await constructors.

 ### Separate proxies for HTTP and HTTPS
@@
-Use `INFRAHUB_PROXY_MOUNTS_HTTP` and `INFRAHUB_PROXY_MOUNTS_HTTPS` environment variables to configure different proxies for HTTP and HTTPS requests:
+Use either programmatic configuration or environment variables to configure different proxies for HTTP and HTTPS requests:
@@
-<Tabs groupId="async-sync">
-  <TabItem value="Async" default>
-
-  ```python
-  from infrahub_sdk import InfrahubClient
-  # Proxy configuration is read from environment variables
-  client = await InfrahubClient()
-  ```
-
-  </TabItem>
-  <TabItem value="Sync" default>
-
-  ```python
-  from infrahub_sdk import InfrahubClientSync
-  # Proxy configuration is read from environment variables
-  client = InfrahubClientSync()
-  ```
-
-  </TabItem>
-</Tabs>
+<Tabs groupId="async-sync">
+  <TabItem value="Async" default>
+
+  ```python
+  from infrahub_sdk import Config, InfrahubClient
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClient(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClient()
+  ```
+
+  </TabItem>
+  <TabItem value="Sync">
+
+  ```python
+  from infrahub_sdk import Config, InfrahubClientSync
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClientSync(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClientSync()
+  ```
+
+  </TabItem>
+</Tabs>

docs/docs/python-sdk/guides/client.mdx (2)

91-91: Pluralize “environment variable” when referencing two variables

Tighten wording for correctness.

-  client = await InfrahubClient() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClient() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables
@@
-  client = InfrahubClientSync() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClientSync() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

Also applies to: 100-101

---

245-246: Remove unused Config import in validation snippets

Config isn’t used in these examples.

-  from infrahub_sdk import InfrahubClient, Config
+  from infrahub_sdk import InfrahubClient
@@
-  from infrahub_sdk import InfrahubClientSync, Config
+  from infrahub_sdk import InfrahubClientSync

Also applies to: 266-267

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

docs/docs/python-sdk/guides/client.mdx (7)

70-76: Tabs: remove duplicate default on Sync TabItem (API tokens section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

95-101: Tabs: remove duplicate default on Sync TabItem (Username/Password section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

124-133: Tabs: remove duplicate default on Sync TabItem (Client options section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

157-168: Tabs: remove duplicate default on Sync TabItem (Single proxy section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

191-198: Tabs: remove duplicate default on Sync TabItem (Separate proxies section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

223-235: Tabs: remove duplicate default on Sync TabItem (Default branch section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

---

263-281: Tabs: remove duplicate default on Sync TabItem (Validation section)

Only one TabItem per Tabs group should be default. The Async tab is already default.

Apply this diff:

-  <TabItem value="Sync" default>
+  <TabItem value="Sync">

docs/docs/python-sdk/guides/client.mdx (3)

91-92: Clarify environment-variable wording for username/password

Use “credentials … environment variables” (plural) rather than “token … environment variable”.

Apply this diff:

-  client = InfrahubClient() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClient() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables
@@
-  client = InfrahubClientSync() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClientSync() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

Please also verify that the exact env var names are INFRAHUB_USERNAME and INFRAHUB_PASSWORD as implemented by the SDK.

Also applies to: 100-101

---

181-201: Add programmatic proxy_mounts examples alongside env-vars

Since you document INFRAHUB_PROXY_MOUNTS_{HTTP,HTTPS}, also show how to configure the same via Config(proxy_mounts={...}) for parity with the single-proxy examples.

Apply this diff:

   <Tabs groupId="async-sync">
-  <TabItem value="Async" default>
-
-  ```python
-  from infrahub_sdk import InfrahubClient
-  # Proxy configuration is read from environment variables
-  client = InfrahubClient()
-  ```
+  <TabItem value="Async" default>
+
+  ```python
+  from infrahub_sdk import Config, InfrahubClient
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClient(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClient()
+  ```
@@
-  <TabItem value="Sync" default>
-
-  ```python
-  from infrahub_sdk import InfrahubClientSync
-  # Proxy configuration is read from environment variables
-  client = InfrahubClientSync()
-  ```
+  <TabItem value="Sync">
+
+  ```python
+  from infrahub_sdk import Config, InfrahubClientSync
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClientSync(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClientSync()
+  ```

Note: Please confirm that Config(proxy_mounts={...}) is supported and the keys are precisely "http"/"https".

---

`202-205`: **Clarify behavior when both proxy and proxy_mounts are provided**

You warn they’re mutually exclusive. Consider stating what happens if both are set (e.g., explicit error vs. one taking precedence) to avoid ambiguity.


Would you like me to draft a short note reflecting the SDK’s actual behavior (e.g., “the client raises a ValueError if both are configured”) once you confirm?

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**

**💡 Knowledge Base configuration:**

- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 88c53cef2838285b0007041944c1fb6a2ad4ad1e and 0f7de7443b595b5f8e87022ac6fd7b73760e969b.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/docs/python-sdk/guides/client.mdx` (5 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx</summary>

[grammar] ~4-~4: There might be a mistake here.
Context: ...ient --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';  #...

(QB_NEW_EN)

---

[grammar] ~15-~15: There might be a mistake here.
Context: ...## Prerequisites  - Python 3.9 or higher - Infrahub SDK installed (`pip install inf...

(QB_NEW_EN)

---

[grammar] ~16-~16: There might be a mistake here.
Context: ...rahub-sdk` or `poetry add infrahub-sdk`) - Access to an Infrahub instance (local or...

(QB_NEW_EN)

---

[grammar] ~17-~17: There might be a mistake here.
Context: ...o an Infrahub instance (local or remote) - Valid credentials (API token or username...

(QB_NEW_EN)

---

[grammar] ~83-~83: There might be a mistake here.
Context: ...okens)  For interactive authentication, use username and password. The SDK automati...

(QB_NEW_EN)

</details>

</details>

</details>

<details>
<summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)</summary>

* GitHub Check: Cloudflare Pages

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx (1)</summary>

`146-154`: **LGTM: Async single-proxy example (no constructor await, correct env var)**

Solid example: constructor isn’t awaited and INFRAHUB_PROXY is correctly demonstrated.

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

docs/docs/python-sdk/guides/client.mdx (2)

172-201: Add programmatic proxy_mounts example (mirror single-proxy section)

To fully document INFRAHUB_PROXY_MOUNTS usage (and parity with the single-proxy example), include a Config-based example showing proxy_mounts. Also ensure only one TabItem has default (currently OK).

Apply this diff to enrich both Async and Sync examples:

   <Tabs groupId="async-sync">
-  <TabItem value="Async" default>
+  <TabItem value="Async" default>
 
   ```python
-  from infrahub_sdk import InfrahubClient
-  # Proxy configuration is read from environment variables
-  client = InfrahubClient()
+  from infrahub_sdk import Config, InfrahubClient
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClient(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClient()

@@

• from infrahub_sdk import InfrahubClientSync

• Proxy configuration is read from environment variables

• client = InfrahubClientSync()

• from infrahub_sdk import Config, InfrahubClientSync

• Programmatic configuration

• config = Config(proxy_mounts={

•  "http": "http://http-proxy.example.com:8080",
  

•  "https": "http://https-proxy.example.com:8080",
  

• })
• client = InfrahubClientSync(config=config)

• Or using environment variables

• export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080

• export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080

• client = InfrahubClientSync()

---

`245-260`: **Fix top-level await in “Validation” async example**

Running `await test_connection()` at the top level will fail in a regular Python script. Use `asyncio.run(...)`.


Apply this diff:

```diff
-  from infrahub_sdk import InfrahubClient, Config
+  from infrahub_sdk import InfrahubClient, Config
+  import asyncio
@@
-  # Run the test
-  await test_connection()
+  # Run the test
+  asyncio.run(test_connection())

docs/docs/python-sdk/guides/client.mdx (2)

90-92: Grammar: refer to multiple environment variables and credentials

Use plural and clarify that credentials are read (not “token”) for the username/password path.

Apply this diff:

-  client = InfrahubClient() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClient() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

-  client = InfrahubClientSync() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClientSync() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

Also applies to: 98-101

---

213-221: Async snippet: avoid implicit top-level awaits in Step 5

The snippet uses await without showing an event loop. Either note it’s inside an async context or wrap with asyncio.run(...) for copy-pasteability.

Apply this diff:

-  from infrahub_sdk import InfrahubClient, Config
-  config = Config(default_branch="other-branch")
-  client_other_branch = InfrahubClient(config=config)
-
-  tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
-  tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+  from infrahub_sdk import InfrahubClient, Config
+  import asyncio
+
+  async def main():
+      config = Config(default_branch="other-branch")
+      client_other_branch = InfrahubClient(config=config)
+      tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
+      tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+
+  asyncio.run(main())

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

docs/docs/python-sdk/guides/client.mdx (2)

247-253: Make the async default-branch example runnable (avoid top-level await)

For consistency with the Validation section and typical Python usage, avoid top-level awaits by wrapping in an async function and using asyncio.run.

Apply this diff:

-  from infrahub_sdk import InfrahubClient, Config
+  from infrahub_sdk import InfrahubClient, Config
+  import asyncio
@@
-  client_other_branch = InfrahubClient(config=config)
-
-  tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
-  tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+  client_other_branch = InfrahubClient(config=config)
+
+  async def main():
+      tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
+      tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+
+  asyncio.run(main())

---

278-281: Remove unused import in async validation sample

Config isn’t used in this snippet.

Apply this diff:

-  from infrahub_sdk import InfrahubClient, Config
+  from infrahub_sdk import InfrahubClient
   import asyncio

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

docs/docs/python-sdk/guides/client.mdx (1)

90-92: Clarify wording: use “credentials” and plural “variables” (not “token … variable”)

Adjust comments to avoid implying a single “token” and fix singular “variable.”

-  client = InfrahubClient() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClient() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

-  client = InfrahubClientSync() # token is read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variable
+  client = InfrahubClientSync() # credentials are read from the INFRAHUB_USERNAME and INFRAHUB_PASSWORD environment variables

Also applies to: 99-101

docs/docs/python-sdk/guides/client.mdx (3)

172-201: Add programmatic proxy_mounts examples (parity with single-proxy section)

For completeness and parity, include Config(proxy_mounts={...}) examples alongside the env-var approach in both Async and Sync tabs.

   <Tabs groupId="async-sync">
     <TabItem value="Async" default>
 
-  ```python
-  from infrahub_sdk import InfrahubClient
-  # Proxy configuration is read from environment variables
-  client = InfrahubClient()
-  ```
+  ```python
+  from infrahub_sdk import Config, InfrahubClient
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClient(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClient()
+  ```
 
     </TabItem>
     <TabItem value="Sync">
 
-  ```python
-  from infrahub_sdk import InfrahubClientSync
-  # Proxy configuration is read from environment variables
-  client = InfrahubClientSync()
-  ```
+  ```python
+  from infrahub_sdk import Config, InfrahubClientSync
+  # Programmatic configuration
+  config = Config(proxy_mounts={
+      "http": "http://http-proxy.example.com:8080",
+      "https": "http://https-proxy.example.com:8080",
+  })
+  client = InfrahubClientSync(config=config)
+
+  # Or using environment variables
+  # export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
+  # export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080
+  client = InfrahubClientSync()
+  ```
 
     </TabItem>
   </Tabs>

---

213-221: Avoid top-level await in Step 5 async example

Wrap in an async function and call via asyncio.run for a copy-pastable snippet.

-  from infrahub_sdk import InfrahubClient, Config
-  config = Config(default_branch="other-branch")
-  client_other_branch = InfrahubClient(config=config)
-
-  tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
-  tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+  from infrahub_sdk import InfrahubClient, Config
+  import asyncio
+
+  async def main():
+      config = Config(default_branch="other-branch")
+      client_other_branch = InfrahubClient(config=config)
+      tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
+      tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+
+  asyncio.run(main())

---

244-261: Remove unused Config imports in Validation examples

Config isn’t used in either block; trimming imports keeps examples minimal.

-  from infrahub_sdk import InfrahubClient, Config
+  from infrahub_sdk import InfrahubClient

-  from infrahub_sdk import InfrahubClientSync, Config
+  from infrahub_sdk import InfrahubClientSync

Also applies to: 266-281

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

docs/docs/python-sdk/guides/client.mdx (4)

92-97: Pluralize “environment variable(s)” where multiple vars are exported

These sentences export two variables; use “variables” (plural).

Apply this diff:

-      We need to export the address and API token as an environment variable:
+      Export the address and API token as environment variables:
@@
-      We need to export the address and API token as an environment variable:
+      Export the address and API token as environment variables:

Also applies to: 121-126

---

213-223: Avoid top-level await in Step 3 snippets; wrap in coroutine and run

These examples won’t run as-is in a standard script. Wrap calls in an async function and run with asyncio to make the samples copy-pasteable.

Apply this diff:

-  from infrahub_sdk import InfrahubClient, Config
-  config = Config(address="http://localhost:8000", api_token="token", default_branch="other-branch")
-  client_other_branch = InfrahubClient(config=config)
-
-  tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
-  tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+  import asyncio
+  from infrahub_sdk import InfrahubClient, Config
+
+  async def main():
+      config = Config(address="http://localhost:8000", api_token="token", default_branch="other-branch")
+      client_other_branch = InfrahubClient(config=config)
+      tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
+      tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+
+  asyncio.run(main())
@@
-  from infrahub_sdk import InfrahubClient
-  client_other_branch = InfrahubClient()
-
-  tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
-  tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+  import asyncio
+  from infrahub_sdk import InfrahubClient
+
+  async def main():
+      client_other_branch = InfrahubClient()
+      tag_other_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED")
+      tag_main_branch = await client_other_branch.get(kind="BuiltinTag", name__value="RED", branch="main")
+
+  asyncio.run(main())

Also applies to: 234-240

---

401-425: Add programmatic examples for proxy_mounts to mirror single-proxy section

For parity, show how to set proxy_mounts via configuration alongside the ENV examples.

Apply this diff:

 In some network environments, you might need to route HTTP and HTTPS traffic through different proxy servers. Use the `INFRAHUB_PROXY_MOUNTS_HTTP` and `INFRAHUB_PROXY_MOUNTS_HTTPS` environment variables for this purpose:
 
 ```bash
 export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080
 export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080

• from infrahub_sdk import InfrahubClient

• Proxy configuration is read from environment variables

• client = InfrahubClient()

• from infrahub_sdk import Config, InfrahubClient

• Programmatic configuration

• config = Config(proxy_mounts={

•  "http": "http://http-proxy.example.com:8080",
  

•  "https": "http://https-proxy.example.com:8080",
  

• })
• client = InfrahubClient(config=config)

• Or using environment variables

• export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080

• export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080

• client = InfrahubClient()

@@

• from infrahub_sdk import InfrahubClientSync

• Proxy configuration is read from environment variables

• client = InfrahubClientSync()

• from infrahub_sdk import Config, InfrahubClientSync

• Programmatic configuration

• config = Config(proxy_mounts={

•  "http": "http://http-proxy.example.com:8080",
  

•  "https": "http://https-proxy.example.com:8080",
  

• })
• client = InfrahubClientSync(config=config)

• Or using environment variables

• export INFRAHUB_PROXY_MOUNTS_HTTP=http://http-proxy.example.com:8080

• export INFRAHUB_PROXY_MOUNTS_HTTPS=http://https-proxy.example.com:8080

• client = InfrahubClientSync()

---

`339-356`: **Silence Vale in this debug-logging example to avoid false positives**

Avoids style/spelling checks on code identifiers inside this fenced block.

Apply this diff:

```diff
-  ```python
+  <!-- vale off -->
+  ```python
   from infrahub_sdk import Config, InfrahubClient
   config = Config(echo_graphql_queries=True)
   client = InfrahubClient(config=config)

@@

• from infrahub_sdk import InfrahubClient
  client = InfrahubClient()  # debug flag state is read from the INFRAHUB_ECHO_GRAPHQL_QUERIES environment variables

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**

**💡 Knowledge Base configuration:**

- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 42c601f05176f92aed3fc3e6cbe458713e5b8515 and 37ee6051a402e3fa077f4ffdf2dd0d9d0244a352.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `docs/docs/python-sdk/guides/client.mdx` (1 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx</summary>

[grammar] ~4-~4: There might be a mistake here.
Context: ...ient --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';  #...

(QB_NEW_EN)

---

[grammar] ~19-~19: There might be a mistake here.
Context: ...## Prerequisites  - Python 3.9 or higher - Infrahub SDK installed (`pip install inf...

(QB_NEW_EN)

---

[grammar] ~20-~20: There might be a mistake here.
Context: ...rahub-sdk` or `poetry add infrahub-sdk`) - Access to an Infrahub instance (local or...

(QB_NEW_EN)

---

[grammar] ~21-~21: There might be a mistake here.
Context: ...o an Infrahub instance (local or remote) - Valid credentials (API token or username...

(QB_NEW_EN)

---

[grammar] ~27-~27: There might be a mistake here.
Context: ...best fits your application architecture: - **Asynchronous client** (`InfrahubClient`)...

(QB_NEW_EN)

---

[grammar] ~28-~28: There might be a mistake here.
Context: ...ns using Python's `async`/`await` syntax - **Synchronous client** (`InfrahubClientSyn...

(QB_NEW_EN)

---

[grammar] ~29-~29: There might be a mistake here.
Context: ...itional synchronous workflows or scripts :::  <Tabs groupId="async-sync"> <TabIte...

(QB_NEW_EN)

---

[grammar] ~63-~63: There might be a mistake here.
Context: ...password.  :::info Configuration Methods You can configure the client in two ways...

(QB_NEW_EN)

---

[grammar] ~64-~64: There might be a mistake here.
Context: ...ou can configure the client in two ways: 1. **Environment variables**: Ideal for sensi...

(QB_NEW_EN)

---

[grammar] ~140-~140: There might be a mistake here.
Context: ...ssword  For interactive authentication, use username and password. The SDK automati...

(QB_NEW_EN)

---

[grammar] ~259-~259: There might be a mistake here.
Context: ...ello_world.py ```  :::danger File Naming Avoid naming your script `test.py` as th...

(QB_NEW_EN)

---

[grammar] ~260-~260: There might be a mistake here.
Context: ...ng modules and the SDK's internal tests. :::  2. Add the following code to `hello...

(QB_NEW_EN)

---

[grammar] ~273-~273: There might be a mistake here.
Context: ...rahubClient     async def hello_world():       client = InfrahubClient(config=Config(ad...

(QB_NEW_EN)

</details>

</details>
<details>
<summary>🪛 Gitleaks (8.27.2)</summary>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx</summary>

315-315: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

</details>

</details>
<details>
<summary>🪛 GitHub Check: markdown-lint</summary>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx</summary>

[failure] 285-285: Fenced code blocks should be surrounded by blank lines
docs/docs/python-sdk/guides/client.mdx:285 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md031.md

---

[failure] 283-283: Multiple consecutive blank lines
docs/docs/python-sdk/guides/client.mdx:283 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md

---

[failure] 276-276: Code block style
docs/docs/python-sdk/guides/client.mdx:276 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md

---

[failure] 272-272: Multiple consecutive blank lines
docs/docs/python-sdk/guides/client.mdx:272 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md012.md

---

[failure] 177-177: Code block style
docs/docs/python-sdk/guides/client.mdx:177 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md

---

[failure] 147-147: Code block style
docs/docs/python-sdk/guides/client.mdx:147 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md

---

[failure] 111-111: Code block style
docs/docs/python-sdk/guides/client.mdx:111 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md

---

[failure] 82-82: Code block style
docs/docs/python-sdk/guides/client.mdx:82 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md046.md

---

[failure] 65-65: Lists should be surrounded by blank lines
docs/docs/python-sdk/guides/client.mdx:65 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "1. **Environment variables**: ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md

---

[failure] 28-28: Lists should be surrounded by blank lines
docs/docs/python-sdk/guides/client.mdx:28 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **Asynchronous client** (`In..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md

</details>

</details>
<details>
<summary>🪛 GitHub Actions: CI</summary>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx</summary>

[error] 80-80: Vale: Infrahub.swap: Use 'configuration' instead of 'Config'.

---

[warning] 249-249: Vale: Infrahub.sentence-case: 'Hello World example' should use sentence case.

---

[warning] 251-251: Vale: Infrahub.simple-easy: Remove simple and avoid words that minimize the effort level required.

---

[error] 260-260: Vale: Infrahub.spelling: Did you really mean 'SDK's'?

---

[error] 270-270: Vale: Infrahub.spelling: Did you really mean 'infrahub_sdk'?

---

[error] 274-274: Vale: Infrahub.swap: Use 'configuration' instead of 'config'.

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (3)</summary><blockquote>

<details>
<summary>docs/docs/python-sdk/guides/client.mdx (3)</summary>

`371-379`: **Single-proxy samples look correct and aligned with ENV usage**

Good use of `proxy` and `INFRAHUB_PROXY` with consistent async/sync examples.



Also applies to: 384-392

---

`427-429`: **Good: explicit error when both `proxy` and `proxy_mounts` are set**

Clear mutual-exclusivity guidance, including the `ValueError` detail.

---

`32-57`: **General MDX structure LGTM**

Tabs/TabItem usage is consistent; headings and proxy sections are well structured.



Also applies to: 360-366, 397-400

</details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

docs/docs/python-sdk/guides/client.mdx (2)

83-85: Use “Configuration” (not “Config”) in non-code labels and prose to satisfy Vale.

Update TabItem labels/values and nearby prose. Keep the class name Config in code.

-<TabItem value="Config" default>
+<TabItem value="Configuration" default>
@@
-We can set the address and API token directly in the `Config` object:
+You can set the address and API token directly via a configuration object (`Config`):

-<TabItem value="Config" default>
+<TabItem value="Configuration" default>
@@
-We can set the address and API token directly in the `Config` object:
+You can set the address and API token directly via a configuration object (`Config`):

-<TabItem value="Config" default>
+<TabItem value="Configuration" default>
@@
-We can set the address, username and password directly in the `Config` object:
+You can set the address, username, and password directly via a configuration object (`Config`):

-<TabItem value="Config" default>
+<TabItem value="Configuration" default>
@@
-We can set the address, username and password directly in the `Config` object:
+You can set the address, username, and password directly via a configuration object (`Config`):

-<TabItem value="Config" default>
+<TabItem value="Configuration" default>

-  <TabItem value="Config" default>
+  <TabItem value="Configuration" default>

Also applies to: 112-116, 148-152, 178-182, 217-218, 341-341

---

319-320: Do not commit token-like values (Gitleaks). Replace with a placeholder.

The hard-coded value looks like a real API key and is flagged by Gitleaks. Replace it with a placeholder.

-export INFRAHUB_API_TOKEN="06438eb2-8019-4776-878c-0941b1f1d1ec" # This is the default token
+export INFRAHUB_API_TOKEN="<YOUR_API_TOKEN>"

docs/docs/python-sdk/guides/client.mdx (3)

95-95: Pluralize “environment variables.”

Two variables are exported in each section; the prose should be plural.

-We need to export the address and API token as an environment variable:
+We need to export the address and API token as environment variables:

Also applies to: 124-124

---

358-359: Grammar: “environment variable” (singular).

Only one variable is referenced here.

-  client = InfrahubClient()  # debug flag state is read from the INFRAHUB_ECHO_GRAPHQL_QUERIES environment variables
+  client = InfrahubClient()  # debug flag state is read from the INFRAHUB_ECHO_GRAPHQL_QUERIES environment variable

---

368-433: Consider adding programmatic examples for proxy_mounts (nice to have).

You document INFRAHUB_PROXY_MOUNTS_* via env vars, but some users may prefer explicit configuration in code. Consider adding a short programmatic example (mirrored for Sync) alongside the env-var version:

from infrahub_sdk import Config, InfrahubClient
config = Config(proxy_mounts={
    "http": "http://http-proxy.example.com:8080",
    "https": "http://https-proxy.example.com:8080",
})
client = InfrahubClient(config=config)

Note: Keep the mutual-exclusivity warning as-is.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.