Release 0.1.2

Author: polytomic-sdk-bot

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ jobs:
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -26,7 +26,7 @@ jobs:
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -45,7 +45,7 @@ jobs:
       - name: Set up python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.7
+          python-version: 3.8
       - name: Bootstrap poetry
         run: |
           curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1

README.md

@@ -40,6 +40,14 @@ client = AsyncPolytomic(
 ```
 <!-- End Async Usage  -->
 
+<!-- Begin Status, generated by Fern  -->
+# Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+<!-- End Status  -->
+
 <!-- Begin Contributing, generated by Fern  -->
 # Contributing
 

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "polytomic"
-version = "0.1.1"
+version = "0.1.2"
 description = ""
 readme = "README.md"
 authors = []
@@ -9,13 +9,24 @@ packages = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.8"
 httpx = ">=0.21.2"
-pydantic = ">= 1.9.2, < 2.5.0"
+pydantic = ">= 1.9.2"
+typing_extensions = ">= 4.0.0"
 
 [tool.poetry.dev-dependencies]
-mypy = "0.971"
+mypy = "^1.8.0"
 pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
 
 [build-system]
 requires = ["poetry-core"]

pyproject.toml

@@ -141,6 +141,7 @@
     webhooks,
 )
 from .environment import PolytomicEnvironment
+from .version import __version__
 
 __all__ = [
     "ActivateSyncEnvelope",
@@ -269,6 +270,7 @@
     "WebhookEnvelope",
     "WebhookListEnvelope",
     "WorkTaskStatus",
+    "__version__",
     "bulk_sync",
     "connections",
     "events",

src/polytomic/__init__.py

@@ -1,9 +1,8 @@
-# This file was auto-generated by Fern from our API Definition.
+# This file was auto-generated from our API Definition.
 
 import typing
 
 import httpx
-import typing_extensions
 
 from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from .environment import PolytomicEnvironment
@@ -21,21 +20,49 @@
 
 
 class Polytomic:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+
+        - environment: PolytomicEnvironment. The environment to use for requests from the client. from .environment import PolytomicEnvironment
+
+                                             Defaults to PolytomicEnvironment.DEFAULT
+
+        - x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]].
+
+        - token: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+        - httpx_client: typing.Optional[httpx.Client]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from polytomic.client import Polytomic
+
+    client = Polytomic(
+        x_polytomic_version="YOUR_X_POLYTOMIC_VERSION",
+        token="YOUR_TOKEN",
+    )
+    """
+
     def __init__(
         self,
         *,
         base_url: typing.Optional[str] = None,
         environment: PolytomicEnvironment = PolytomicEnvironment.DEFAULT,
-        x_polytomic_version: typing.Optional[typing_extensions.Literal["2023-04-25"]] = None,
+        x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]] = None,
         token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
-        timeout: typing.Optional[float] = 60,
+        timeout: typing.Optional[float] = None,
         httpx_client: typing.Optional[httpx.Client] = None
     ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
         self._client_wrapper = SyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
             x_polytomic_version=x_polytomic_version,
             token=token,
-            httpx_client=httpx.Client(timeout=timeout) if httpx_client is None else httpx_client,
+            httpx_client=httpx.Client(timeout=_defaulted_timeout) if httpx_client is None else httpx_client,
+            timeout=_defaulted_timeout,
         )
         self.bulk_sync = BulkSyncClient(client_wrapper=self._client_wrapper)
         self.connections = ConnectionsClient(client_wrapper=self._client_wrapper)
@@ -51,21 +78,49 @@ def __init__(
 
 
 class AsyncPolytomic:
+    """
+    Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propogate to these functions.
+
+    Parameters:
+        - base_url: typing.Optional[str]. The base url to use for requests from the client.
+
+        - environment: PolytomicEnvironment. The environment to use for requests from the client. from .environment import PolytomicEnvironment
+
+                                             Defaults to PolytomicEnvironment.DEFAULT
+
+        - x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]].
+
+        - token: typing.Optional[typing.Union[str, typing.Callable[[], str]]].
+
+        - timeout: typing.Optional[float]. The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
+
+        - httpx_client: typing.Optional[httpx.AsyncClient]. The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
+    ---
+    from polytomic.client import AsyncPolytomic
+
+    client = AsyncPolytomic(
+        x_polytomic_version="YOUR_X_POLYTOMIC_VERSION",
+        token="YOUR_TOKEN",
+    )
+    """
+
     def __init__(
         self,
         *,
         base_url: typing.Optional[str] = None,
         environment: PolytomicEnvironment = PolytomicEnvironment.DEFAULT,
-        x_polytomic_version: typing.Optional[typing_extensions.Literal["2023-04-25"]] = None,
+        x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]] = None,
         token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
-        timeout: typing.Optional[float] = 60,
+        timeout: typing.Optional[float] = None,
         httpx_client: typing.Optional[httpx.AsyncClient] = None
     ):
+        _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
         self._client_wrapper = AsyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
             x_polytomic_version=x_polytomic_version,
             token=token,
-            httpx_client=httpx.AsyncClient(timeout=timeout) if httpx_client is None else httpx_client,
+            httpx_client=httpx.AsyncClient(timeout=_defaulted_timeout) if httpx_client is None else httpx_client,
+            timeout=_defaulted_timeout,
         )
         self.bulk_sync = AsyncBulkSyncClient(client_wrapper=self._client_wrapper)
         self.connections = AsyncConnectionsClient(client_wrapper=self._client_wrapper)

src/polytomic/client.py

@@ -3,14 +3,22 @@
 from .api_error import ApiError
 from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper
 from .datetime_utils import serialize_datetime
+from .file import File, convert_file_dict_to_httpx_tuples
+from .http_client import AsyncHttpClient, HttpClient
 from .jsonable_encoder import jsonable_encoder
 from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
 
 __all__ = [
     "ApiError",
     "AsyncClientWrapper",
+    "AsyncHttpClient",
     "BaseClientWrapper",
+    "File",
+    "HttpClient",
+    "RequestOptions",
     "SyncClientWrapper",
+    "convert_file_dict_to_httpx_tuples",
     "jsonable_encoder",
     "remove_none_from_dict",
     "serialize_datetime",

src/polytomic/core/__init__.py

@@ -1,28 +1,31 @@
-# This file was auto-generated by Fern from our API Definition.
+# This file was auto-generated from our API Definition.
 
 import typing
 
 import httpx
-import typing_extensions
+
+from .http_client import AsyncHttpClient, HttpClient
 
 
 class BaseClientWrapper:
     def __init__(
         self,
         *,
-        x_polytomic_version: typing.Optional[typing_extensions.Literal["2023-04-25"]] = None,
+        x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]] = None,
         token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         base_url: str,
+        timeout: typing.Optional[float] = None,
     ):
         self._x_polytomic_version = x_polytomic_version
         self._token = token
         self._base_url = base_url
+        self._timeout = timeout
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "polytomic",
-            "X-Fern-SDK-Version": "0.1.1",
+            "X-Fern-SDK-Version": "0.1.2",
         }
         if self._x_polytomic_version is not None:
             headers["X-Polytomic-Version"] = self._x_polytomic_version
@@ -40,28 +43,33 @@ def _get_token(self) -> typing.Optional[str]:
     def get_base_url(self) -> str:
         return self._base_url
 
+    def get_timeout(self) -> typing.Optional[float]:
+        return self._timeout
+
 
 class SyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
-        x_polytomic_version: typing.Optional[typing_extensions.Literal["2023-04-25"]] = None,
+        x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]] = None,
         token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         base_url: str,
+        timeout: typing.Optional[float] = None,
         httpx_client: httpx.Client,
     ):
-        super().__init__(x_polytomic_version=x_polytomic_version, token=token, base_url=base_url)
-        self.httpx_client = httpx_client
+        super().__init__(x_polytomic_version=x_polytomic_version, token=token, base_url=base_url, timeout=timeout)
+        self.httpx_client = HttpClient(httpx_client=httpx_client)
 
 
 class AsyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
-        x_polytomic_version: typing.Optional[typing_extensions.Literal["2023-04-25"]] = None,
+        x_polytomic_version: typing.Optional[typing.Literal["2023-04-25"]] = None,
         token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         base_url: str,
+        timeout: typing.Optional[float] = None,
         httpx_client: httpx.AsyncClient,
     ):
-        super().__init__(x_polytomic_version=x_polytomic_version, token=token, base_url=base_url)
-        self.httpx_client = httpx_client
+        super().__init__(x_polytomic_version=x_polytomic_version, token=token, base_url=base_url, timeout=timeout)
+        self.httpx_client = AsyncHttpClient(httpx_client=httpx_client)

src/polytomic/core/client_wrapper.py

@@ -0,0 +1,38 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+# File typing inspired by the flexibility of types within the httpx library
+# https://github.com/encode/httpx/blob/master/httpx/_types.py
+FileContent = typing.Union[typing.IO[bytes], bytes, str]
+File = typing.Union[
+    # file (or bytes)
+    FileContent,
+    # (filename, file (or bytes))
+    typing.Tuple[typing.Optional[str], FileContent],
+    # (filename, file (or bytes), content_type)
+    typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str]],
+    # (filename, file (or bytes), content_type, headers)
+    typing.Tuple[typing.Optional[str], FileContent, typing.Optional[str], typing.Mapping[str, str]],
+]
+
+
+def convert_file_dict_to_httpx_tuples(
+    d: typing.Dict[str, typing.Union[File, typing.List[File]]]
+) -> typing.List[typing.Tuple[str, File]]:
+    """
+    The format we use is a list of tuples, where the first element is the
+    name of the file and the second is the file object. Typically HTTPX wants
+    a dict, but to be able to send lists of files, you have to use the list
+    approach (which also works for non-lists)
+    https://github.com/encode/httpx/pull/1032
+    """
+
+    httpx_tuples = []
+    for key, file_like in d.items():
+        if isinstance(file_like, list):
+            for file_like_item in file_like:
+                httpx_tuples.append((key, file_like_item))
+        else:
+            httpx_tuples.append((key, file_like))
+    return httpx_tuples