clean up client.py

Author: alexluck-sift

python/lib/sift_client/client.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import NamedTuple
-
 from sift_client.errors import _sift_client_experimental_warning
 from sift_client.resources import (
     AssetsAPI,
@@ -22,23 +20,11 @@
     WithGrpcClient,
     WithRestClient,
 )
+from sift_client.util.util import AsyncAPIs
 
 _sift_client_experimental_warning()
 
 
-class AsyncAPIs(NamedTuple):
-    """Simple accessor for the asynchronous APIs, still uses the SiftClient instance."""
-
-    """Instance of the Ping API for making asynchronous requests."""
-    ping: PingAPIAsync
-    """Instance of the Assets API for making asynchronous requests."""
-    assets: AssetsAPIAsync
-    """Instance of the Calculated Channels API for making asynchronous requests."""
-    calculated_channels: CalculatedChannelsAPIAsync
-    """Instance of the Runs API for making asynchronous requests."""
-    runs: RunsAPIAsync
-
-
 class SiftClient(
     WithGrpcClient,
     WithRestClient,
@@ -48,7 +34,7 @@ class SiftClient(
 
     It provides both synchronous and asynchronous interfaces, strong type checking, and a Pythonic API design.
 
-    Example usage:
+    Examples:
         from sift_client import SiftClient
         from datetime import datetime
 
@@ -72,14 +58,21 @@ class SiftClient(
         response = await sift.async_.ping.ping()
     """
 
-    """Instance of the Ping API for making synchronous requests."""
+
     ping: PingAPI
-    """Instance of the Assets API for making synchronous requests."""
+    """Instance of the Ping API for making synchronous requests."""
+
     assets: AssetsAPI
-    """Instance of the Calculated Channels API for making synchronous requests."""
+    """Instance of the Assets API for making synchronous requests."""
+
     calculated_channels: CalculatedChannelsAPI
-    """Instance of the Runs API for making synchronous requests."""
+    """Instance of the Calculated Channels API for making synchronous requests."""
+
     runs: RunsAPI
+    """Instance of the Runs API for making synchronous requests."""
+
+    async_: AsyncAPIs
+    """Accessor for the asynchronous APIs. All asynchronous APIs are available as attributes on this accessor."""
 
     def __init__(
         self,

python/lib/sift_client/util/util.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+from typing import NamedTuple
+
+from sift_client.resources import (
+    AssetsAPIAsync,
+    CalculatedChannelsAPIAsync,
+    PingAPIAsync,
+    RunsAPIAsync,
+)
+
+
+class AsyncAPIs(NamedTuple):
+    """Simple accessor for the asynchronous APIs, still uses the SiftClient instance."""
+
+    ping: PingAPIAsync
+    """Instance of the Ping API for making asynchronous requests."""
+
+    assets: AssetsAPIAsync
+    """Instance of the Assets API for making asynchronous requests."""
+
+    calculated_channels: CalculatedChannelsAPIAsync
+    """Instance of the Calculated Channels API for making asynchronous requests."""
+
+    runs: RunsAPIAsync
+    """Instance of the Runs API for making asynchronous requests."""

python/mkdocs.yml

@@ -36,7 +36,10 @@ plugins:
       default_handler: python
       handlers:
         python:
+          import:
+            - https://docs.python.org/3/objects.inv
           options:
+            show_docstring_examples: false
             load_external_modules: true
             show_source: false
             find_stubs_package: true
@@ -56,7 +59,7 @@ plugins:
             show_symbol_type_heading: true
             show_symbol_type_toc: true
             summary: true
-            # Custom Griffe extension to only inspect sync_stubs
+            # Custom Griffe extension to inspect the sync stubs and generate their signatures
             extensions:
               - griffe_extensions/sync_stubs_inspector.py:InspectSpecificObjects:
                   paths:

python/pyproject.toml

@@ -55,7 +55,7 @@ development = [
     "ruff",
 ]
 build = ["pdoc==14.5.0", "build==1.2.1"]
-docs = ["mkdocs", "mkdocs-material", "mkdocstrings[python]", "mkdocs-include-markdown-plugin"]
+docs = ["mkdocs", "mkdocs-material", "mkdocstrings[python]", "mkdocs-include-markdown-plugin", "mkdocs-api-autonav"]
 openssl = ["pyOpenSSL<24.0.0", "types-pyOpenSSL<24.0.0", "cffi~=1.14"]
 tdms = ["npTDMS~=1.9"]
 rosbags = ["rosbags~=0.0"]