feat: add docs for polywrap-client

Author: Niraj-Kamdar

docs/poetry.lock

@@ -17,6 +17,7 @@ polywrap-core = { path = "../packages/polywrap-core", develop = true }
 polywrap-wasm = { path = "../packages/polywrap-wasm", develop = true }
 polywrap-plugin = { path = "../packages/polywrap-plugin", develop = true }
 polywrap-uri-resolvers = { path = "../packages/polywrap-uri-resolvers", develop = true }
+polywrap-client = { path = "../packages/polywrap-client", develop = true }
 
 [tool.poetry.group.dev.dependencies]
 sphinx = "^6.1.3"

docs/pyproject.toml

@@ -16,6 +16,7 @@ Welcome to polywrap-client's documentation!
    polywrap-wasm/modules.rst
    polywrap-plugin/modules.rst
    polywrap-uri-resolvers/modules.rst
+   polywrap-client/modules.rst
 
 
 

docs/source/index.rst

@@ -0,0 +1,3 @@
+from ..conf import *
+
+import polywrap_client

docs/source/polywrap-client/conf.py

@@ -0,0 +1,7 @@
+polywrap_client
+===============
+
+.. toctree::
+   :maxdepth: 4
+
+   polywrap_client

docs/source/polywrap-client/modules.rst

@@ -0,0 +1,7 @@
+polywrap\_client.client module
+==============================
+
+.. automodule:: polywrap_client.client
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/polywrap-client/polywrap_client.client.rst

@@ -0,0 +1,18 @@
+polywrap\_client package
+========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   polywrap_client.client
+
+Module contents
+---------------
+
+.. automodule:: polywrap_client
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/polywrap-client/polywrap_client.rst

@@ -1 +1,2 @@
+"""This package contains the Polywrap client implementation."""
 from .client import *

packages/polywrap-client/polywrap_client/__init__.py

@@ -1,3 +1,4 @@
+"""This module contains the Polywrap client implementation."""
 from __future__ import annotations
 
 import json
@@ -13,12 +14,12 @@
     GetManifestOptions,
     InvokerOptions,
     IUriResolutionContext,
-    UriPackage,
-    UriResolver,
-    UriWrapper,
     TryResolveUriOptions,
     Uri,
+    UriPackage,
     UriPackageOrWrapper,
+    UriResolver,
+    UriWrapper,
     Wrapper,
 )
 from polywrap_manifest import AnyWrapManifest
@@ -28,49 +29,78 @@
 
 @dataclass(slots=True, kw_only=True)
 class PolywrapClientConfig(ClientConfig):
-    pass
+    """Defines the config type for the Polywrap client.
+
+    Attributes:
+        envs (Dict[Uri, Env]): Dictionary of environments \
+            where key is URI and value is env.
+        interfaces (Dict[Uri, List[Uri]]): Dictionary of interfaces \
+            and their implementations where key is interface URI \
+            and value is list of implementation URIs.
+        resolver (UriResolver): URI resolver.
+    """
 
 
 class PolywrapClient(Client):
+    """Defines the Polywrap client.
+
+    Attributes:
+        _config (PolywrapClientConfig): The client configuration.
+    """
+
     _config: PolywrapClientConfig
 
     def __init__(self, config: PolywrapClientConfig):
+        """Initialize a new PolywrapClient instance.
+
+        Args:
+            config (PolywrapClientConfig): The polywrap client config.
+        """
         self._config = config
 
     def get_config(self):
+        """Get the client configuration."""
         return self._config
 
     def get_uri_resolver(self) -> UriResolver:
+        """Get the URI resolver."""
         return self._config.resolver
 
     def get_envs(self) -> Dict[Uri, Env]:
+        """Get the dictionary of environment variables."""
         envs: Dict[Uri, Env] = self._config.envs
         return envs
 
     def get_interfaces(self) -> Dict[Uri, List[Uri]]:
+        """Get the interfaces."""
         interfaces: Dict[Uri, List[Uri]] = self._config.interfaces
         return interfaces
 
     def get_implementations(self, uri: Uri) -> Union[List[Uri], None]:
+        """Get the implementations for the given interface URI."""
         interfaces: Dict[Uri, List[Uri]] = self.get_interfaces()
         return interfaces.get(uri)
 
     def get_env_by_uri(self, uri: Uri) -> Union[Env, None]:
+        """Get the environment variables for the given URI."""
         return self._config.envs.get(uri)
 
     async def get_file(self, uri: Uri, options: GetFileOptions) -> Union[bytes, str]:
+        """Get the file from the given wrapper URI."""
         loaded_wrapper = await self.load_wrapper(uri)
         return await loaded_wrapper.get_file(options)
 
     async def get_manifest(
         self, uri: Uri, options: Optional[GetManifestOptions] = None
     ) -> AnyWrapManifest:
+        """Get the manifest from the given wrapper URI."""
         loaded_wrapper = await self.load_wrapper(uri)
         return loaded_wrapper.get_manifest()
 
     async def try_resolve_uri(
         self, options: TryResolveUriOptions[UriPackageOrWrapper]
     ) -> UriPackageOrWrapper:
+        """Try to resolve the given URI."""
         uri = options.uri
         uri_resolver = self._config.resolver
         resolution_context = options.resolution_context or UriResolutionContext()
@@ -82,6 +112,7 @@ async def load_wrapper(
         uri: Uri,
         resolution_context: Optional[IUriResolutionContext[UriPackageOrWrapper]] = None,
     ) -> Wrapper[UriPackageOrWrapper]:
+        """Load the wrapper for the given URI."""
         resolution_context = resolution_context or UriResolutionContext()
 
         uri_package_or_wrapper = await self.try_resolve_uri(
@@ -101,13 +132,19 @@ async def load_wrapper(
                 f"""
                 Error resolving URI "{uri.uri}"
                 URI not found
-                Resolution Stack: {json.dumps(build_clean_uri_history(resolution_context.get_history()), indent=2)}
+                Resolution Stack: {
+                    json.dumps(
+                        build_clean_uri_history(
+                            resolution_context.get_history()
+                        ), indent=2
+                    )
+                }
                 """
             )
         )
 
-
     async def invoke(self, options: InvokerOptions[UriPackageOrWrapper]) -> Any:
+        """Invoke the given wrapper URI."""
         resolution_context = options.resolution_context or UriResolutionContext()
         wrapper = await self.load_wrapper(
             options.uri, resolution_context=resolution_context

packages/polywrap-client/polywrap_client/client.py

@@ -19,7 +19,7 @@ class ClientConfig:
         interfaces (Dict[Uri, List[Uri]]): Dictionary of interfaces \
             and their implementations where key is interface URI \
             and value is list of implementation URIs.
-        resolver (IUriResolver): URI resolver.
+        resolver (UriResolver): URI resolver.
     """
 
     envs: Dict[Uri, Env] = field(default_factory=dict)