UncountablePythonSDK 0.0.122__py3-none-any.whl → 0.0.123__py3-none-any.whl

docs/conf.py

@@ -27,7 +27,7 @@ extensions = [
     "sphinx_copybutton",
     "sphinx_favicon",
 ]
-myst_enable_extensions = ["fieldlist", "deflist"]
+myst_enable_extensions = ["fieldlist", "deflist", "colon_fence"]
 
 autoapi_dirs = ["../uncountable"]
 autoapi_options = [

docs/index.md

@@ -3,14 +3,114 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/UncountablePythonSDK)
 
 
-`Uncountable Python SDK` is a python package that allows interacting with the uncountable platform
+The Uncountable Python SDK is a python package that provides a wrapper around the Uncountable REST API.
+
+Using this SDK provides the following advantages:
+
+- In-editor parameter/type safety
+- Automatic parsing of response data.
+- Reduced code boilerplate
+- Helper methods
+
+## Getting Started
+The first step in any integration is to create a [Client](uncountable.core.client.Client) object. The client provides access to all available SDK methods, and includes built-in request authentication & error propagation.
+
+### Creating a Client
+Create a client using one of the supported authentication mechanisms. API credentials can be generated by a member of Uncountable staff.
+
+::::{tab-set}
+:::{tab-item} Basic Auth
+```{literalinclude} ../examples/basic_auth.py
+```
+:::
+
+:::{tab-item} OAuth
+```{literalinclude} ../examples/oauth.py
+```
+:::
+::::
+
+The provided code examples assume that a Client has been created and stored in the `client` variable
+
+
+### Basic Usage
+
+:::{dropdown} List Ingredient Names & IDs
+```{code-block} python
+from uncountable.types import entity_t, id_source_t
+
+client.list_id_source(
+    spec=id_source_t.IdSourceSpecEntity(entity_type=entity_t.EntityType.INGREDIENT),
+    search_label="",
+)
+```
+Example Response:
+```code
+Data(
+    results=[
+        IdName(id=1, name='Filler'), 
+        IdName(id=2, name='Calcium Oxide 2'), 
+        IdName(id=3, name='Carbon Black'),
+    ]
+)
+```
+:::
+
+:::{dropdown} Create an Experiment
+```{code-block} python
+client.create_recipe(material_family_id=1, workflow_id=1, name="Example Recipe")
+```
+Example Response:
+```code
+Data(result_id=52271)
+```
+:::
+
+:::{dropdown} Upload a file
+```{code-block} python
+from uncountable.core.file_upload import MediaFileUpload
+
+client.upload_files(file_uploads=[MediaFileUpload(path="/path/to/local/example_file.pdf")])
+```
+Example Response:
+```code
+[
+    UploadedFile(name='example_file.pdf', file_id=718)
+]
+```
+:::
+
+[More examples](integration_examples/index)
+
+## Errors
+Client methods will raise Exceptions when the API returns codes in the `3xx`, `4xx` or `5xx` ranges. Ensure all method calls are wrapped in Exception handling logic.
+
+## Pagination
+Many of the Uncountable APIs require pagination to fetch more than 100 results at once. The following code snippet implements pagination to fetch the Names & IDs of all Projects:
+:::{dropdown} Pagination Example
+```{code-block} python
+from uncountable.types import entity_t, id_source_t
+from uncountable.types.api.id_source.list_id_source import IdName
+
+def fetch_all_projects(client: Client) -> list[IdName]:
+    projects: list[IdName] = []
+    while True:
+        response = client.list_id_source(
+            spec=IdSourceSpecEntity(entity_type=entity_t.EntityType.PROJECT),
+            search_label="",
+            offset=len(projects),
+        )
+        projects.extend(response.results)
+        if len(response.results) < 100:
+            return projects
+```
+:::
+
 
 ```{toctree}
-:maxdepth: 2
 :hidden:
-
-quickstart
+Overview <self>
 Available SDK Methods <api/uncountable/core/client/Client>
-SDK Reference <api/uncountable/index>
+integration_examples/index
+SDK Reference <autoapi/uncountable/index>
 ```
-

docs/integration_examples/create_ingredient.md

@@ -0,0 +1,43 @@
+# Create an Ingredient
+
+Use the `create_or_update_entity` method to create Ingredients.
+
+The following fields are required when creating an Ingredient:
+- `name`: The name of the Ingredient
+- `core_ingredient_ingredientMaterialFamilies`: The list of material families in which to include the Ingredient
+
+The reference name of the default definition of Ingredients is `uncIngredient`
+
+This is an example of a minimal ingredient creation call
+
+```{code-block} python
+from uncountable.types import entity_t, field_values_t, identifier_t
+
+client.create_or_update_entity(
+    entity_type=entity_t.EntityType.INGREDIENT,
+    definition_key=identifier_t.IdentifierKeyRefName(ref_name="uncIngredient"),
+    field_values=[
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="core_ingredient_ingredientMaterialFamilies"
+            ),
+            value=field_values_t.FieldValueIds(
+                entity_type=entity_t.EntityType.MATERIAL_FAMILY,
+                identifier_keys=[identifier_t.IdentifierKeyId(id=1)],
+            ),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(ref_name="name"),
+            value=field_values_t.FieldValueText(value="Example Ingredient"),
+        ),
+    ],
+)
+```
+
+Example Response:
+```{code}
+Data(modification_made=True, result_id=3124, entity=None, result_values=None)
+```
+
+Optional fields:
+- `core_ingredient_quantityType`: The quantity type of the ingredient (default is `numeric`)

docs/integration_examples/create_output.md

@@ -0,0 +1,56 @@
+# Create an Output
+
+Use the `create_or_update_entity` method to create Outputs.
+
+The following fields are required when creating an Output:
+- `name`: The name of the Output
+- `core_output_unitsId`: The unit the output is measured in
+- `core_output_outputMaterialFamilies`: The list of material families in which to include the Output
+- `core_output_quantityType`: The quantity type of the output
+
+The reference name of the default definition of Ingredients is `unc_output_definition`
+
+This is an example of a minimal output creation call
+
+```{code-block} python
+from uncountable.types import entity_t, field_values_t, identifier_t
+
+client.create_or_update_entity(
+    entity_type=entity_t.EntityType.OUTPUT,
+    definition_key=identifier_t.IdentifierKeyRefName(ref_name="unc_output_definition"),
+    field_values=[
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(ref_name="name"),
+            value=field_values_t.FieldValueText(value="Example Output"),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(ref_name="core_output_unitsId"),
+            value=field_values_t.FieldValueId(
+                entity_type=entity_t.EntityType.UNITS,
+                identifier_key=identifier_t.IdentifierKeyId(id=1),
+            ),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="core_output_outputMaterialFamilies"
+            ),
+            value=field_values_t.FieldValueIds(
+                entity_type=entity_t.EntityType.MATERIAL_FAMILY,
+                identifier_keys=[identifier_t.IdentifierKeyId(id=1)],
+            ),
+        ),
+        field_values_t.FieldArgumentValue(
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="core_output_quantityType"
+            ),
+            value=field_values_t.FieldValueFieldOption(value="numeric"),
+        ),
+    ],
+)
+```
+
+Example Response:
+
+```{code}
+Data(modification_made=True, result_id=653, entity=None, result_values=None)
+```

docs/integration_examples/index.md

@@ -0,0 +1,6 @@
+# Integration Examples
+
+```{toctree}
+create_ingredient
+create_output
+```

examples/basic_auth.py

@@ -0,0 +1,7 @@
+from uncountable.core.client import Client
+from uncountable.core.types import AuthDetailsApiKey
+
+client = Client(
+    base_url="https://app.uncountable.com",
+    auth_details=AuthDetailsApiKey(api_id="x", api_secret_key="x"),
+)

examples/oauth.py

@@ -0,0 +1,7 @@
+from uncountable.core.client import Client
+from uncountable.core.types import AuthDetailsOAuth
+
+client = Client(
+    base_url="https://app.uncountable.com",
+    auth_details=AuthDetailsOAuth(refresh_token="x"),
+)

pkgs/argument_parser/_is_namedtuple.py

@@ -5,6 +5,9 @@ def is_namedtuple_type(x: Any) -> bool:
     if not hasattr(x, "__annotations__"):
         return False
 
+    if not hasattr(x, "__bases__"):
+        return False
+
     b = x.__bases__
     if len(b) != 1 or b[0] is not tuple:
         return False

pkgs/type_spec/type_info/emit_type_info.py

@@ -267,7 +267,9 @@ def _extract_and_validate_layout(
     for group in ext_info.layout.groups:
         fields = set(group.fields or [])
         for field in fields:
-            assert field in stype.properties, f"layout-refers-to-missing-field:{field}"
+            assert field in stype.properties or field == DISCRIMINATOR_COMMON_NAME, (
+                f"layout-refers-to-missing-field:{field}"
+            )
 
         local_ref_name = None
         if group.ref_name is not None:
@@ -314,6 +316,9 @@ def _pull_property_from_type_recursively(
     return _pull_property_from_type_recursively(stype.base, property_name)
 
 
+DISCRIMINATOR_COMMON_NAME = "type"
+
+
 def _validate_type_ext_info(
     stype: builder.SpecTypeDefnObject,
 ) -> tuple[ExtInfoLayout | None, type_info_t.ExtInfo | None]:
@@ -324,12 +329,16 @@ def _validate_type_ext_info(
     if ext_info.label_fields is not None:
         assert stype.properties is not None
         for name in ext_info.label_fields:
+            if name == DISCRIMINATOR_COMMON_NAME:
+                continue
             prop = _pull_property_from_type_recursively(stype, name)
             assert prop is not None, f"missing-label-field:{name}"
 
     if ext_info.actions is not None:
         assert stype.properties is not None
         for action in ext_info.actions:
+            if action.property == DISCRIMINATOR_COMMON_NAME:
+                continue
             prop = _pull_property_from_type_recursively(stype, action.property)
             assert prop is not None, f"missing-action-field:{action.property}"
 

uncountable/integration/telemetry.py

@@ -1,4 +1,5 @@
 import functools
+import json
 import os
 import time
 import traceback
@@ -32,6 +33,10 @@ def _cast_attributes(attributes: dict[str, base_t.JsonValue]) -> Attributes:
     return cast(Attributes, attributes)
 
 
+def one_line_formatter(record: LogRecord) -> str:
+    return json.dumps(record.to_json(), separators=(",", ":"))
+
+
 @functools.cache
 def get_otel_resource() -> Resource:
     attributes: dict[str, base_t.JsonValue] = {
@@ -60,7 +65,9 @@ def get_otel_tracer() -> Tracer:
 @functools.cache
 def get_otel_logger() -> OTELLogger:
     provider = LoggerProvider(resource=get_otel_resource())
-    provider.add_log_record_processor(BatchLogRecordProcessor(ConsoleLogExporter()))
+    provider.add_log_record_processor(
+        BatchLogRecordProcessor(ConsoleLogExporter(formatter=one_line_formatter))
+    )
     if get_otel_enabled():
         provider.add_log_record_processor(BatchLogRecordProcessor(OTLPLogExporter()))
     _logs.set_logger_provider(provider)

uncountable/types/__init__.py

@@ -64,6 +64,7 @@ from . import identifier_t as identifier_t
 from . import input_attributes_t as input_attributes_t
 from . import inputs_t as inputs_t
 from . import integration_server_t as integration_server_t
+from . import integration_session_t as integration_session_t
 from . import integrations_t as integrations_t
 from .api.uploader import invoke_uploader as invoke_uploader_t
 from . import job_definition_t as job_definition_t
@@ -108,6 +109,7 @@ from .api.recipes import set_recipe_output_file as set_recipe_output_file_t
 from .api.recipes import set_recipe_outputs as set_recipe_outputs_t
 from .api.recipes import set_recipe_tags as set_recipe_tags_t
 from .api.entity import set_values as set_values_t
+from . import sockets_t as sockets_t
 from .api.entity import transition_entity_phase as transition_entity_phase_t
 from .api.recipes import unarchive_recipes as unarchive_recipes_t
 from . import units_t as units_t
@@ -184,6 +186,7 @@ __all__: list[str] = [
     "input_attributes_t",
     "inputs_t",
     "integration_server_t",
+    "integration_session_t",
     "integrations_t",
     "invoke_uploader_t",
     "job_definition_t",
@@ -228,6 +231,7 @@ __all__: list[str] = [
     "set_recipe_outputs_t",
     "set_recipe_tags_t",
     "set_values_t",
+    "sockets_t",
     "transition_entity_phase_t",
     "unarchive_recipes_t",
     "units_t",

uncountable/types/api/entity/export_entities.py

@@ -18,12 +18,24 @@ __all__: list[str] = [
     "Data",
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
+    "ListingAttribute",
 ]
 
 ENDPOINT_METHOD = "POST"
 ENDPOINT_PATH = "api/external/entity/export_entities"
 
 
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.api.entity.export_entities.ListingAttribute",
+    unconverted_values={"value"},
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class ListingAttribute:
+    key: str
+    value: base_t.JsonValue
+
+
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.api.entity.export_entities.Arguments",
@@ -34,6 +46,7 @@ class Arguments:
     type: exports_t.ExportType = exports_t.ExportType.EXCEL
     client_timezone: exports_t.ListingExportUserTimezone | None = None
     limit: int | None = None
+    attributes: list[ListingAttribute] | None = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/client_base.py

@@ -610,6 +610,7 @@ class ClientMethods(ABC):
         type: exports_t.ExportType = exports_t.ExportType.EXCEL,
         client_timezone: exports_t.ListingExportUserTimezone | None = None,
         limit: int | None = None,
+        attributes: list[export_entities_t.ListingAttribute] | None = None,
     ) -> export_entities_t.Data:
         """Uses a structured loading configuration to export entities in the system. This endpoint is asynchronous, and returns the job ID that can be used to query the status of the export.
 
@@ -621,6 +622,7 @@ class ClientMethods(ABC):
             client_timezone=client_timezone,
             limit=limit,
             type=type,
+            attributes=attributes,
         )
         api_request = APIRequest(
             method=export_entities_t.ENDPOINT_METHOD,

uncountable/types/integration_session.py

@@ -0,0 +1,10 @@
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .integration_session_t import IntegrationSessionType as IntegrationSessionType
+from .integration_session_t import IntegrationSessionBase as IntegrationSessionBase
+from .integration_session_t import IntegrationSessionInstrument as IntegrationSessionInstrument
+from .integration_session_t import IntegrationSession as IntegrationSession
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/integration_session_t.py

@@ -0,0 +1,60 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from enum import StrEnum
+import dataclasses
+from pkgs.serialization import serial_class
+from pkgs.serialization import serial_union_annotation
+from . import base_t
+from . import identifier_t
+
+__all__: list[str] = [
+    "IntegrationSession",
+    "IntegrationSessionBase",
+    "IntegrationSessionInstrument",
+    "IntegrationSessionType",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class IntegrationSessionType(StrEnum):
+    INSTRUMENT = "instrument"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.integration_session.IntegrationSessionBase",
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class IntegrationSessionBase:
+    type: IntegrationSessionType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.integration_session.IntegrationSessionInstrument",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class IntegrationSessionInstrument(IntegrationSessionBase):
+    type: typing.Literal[IntegrationSessionType.INSTRUMENT] = IntegrationSessionType.INSTRUMENT
+    equipment_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+IntegrationSession = typing.Annotated[
+    typing.Union[IntegrationSessionInstrument],
+    serial_union_annotation(
+    named_type_path="sdk.integration_session.IntegrationSession",
+        discriminator="type",
+        discriminator_map={
+            "instrument": IntegrationSessionInstrument,
+        },
+    ),
+]
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/sockets.py

@@ -0,0 +1,11 @@
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+# DO NOT MODIFY -- This file is generated by type_spec
+# Kept only for SDK backwards compatibility
+from .sockets_t import SocketRequestBase as SocketRequestBase
+from .sockets_t import SocketRequestType as SocketRequestType
+from .sockets_t import SocketRequestIntegrationSession as SocketRequestIntegrationSession
+from .sockets_t import SocketTokenRequest as SocketTokenRequest
+from .sockets_t import SocketTokenResponse as SocketTokenResponse
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/sockets_t.py

@@ -0,0 +1,70 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# ruff: noqa: E402 Q003
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from enum import StrEnum
+import dataclasses
+from pkgs.serialization import serial_class
+from pkgs.serialization import serial_union_annotation
+from . import base_t
+from . import integration_session_t
+
+__all__: list[str] = [
+    "SocketRequestBase",
+    "SocketRequestIntegrationSession",
+    "SocketRequestType",
+    "SocketTokenRequest",
+    "SocketTokenResponse",
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.sockets.SocketRequestBase",
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class SocketRequestBase:
+    type: SocketRequestType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class SocketRequestType(StrEnum):
+    INTEGRATION_SESSION = "integration_session"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.sockets.SocketRequestIntegrationSession",
+    parse_require={"type"},
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class SocketRequestIntegrationSession(SocketRequestBase):
+    type: typing.Literal[SocketRequestType.INTEGRATION_SESSION] = SocketRequestType.INTEGRATION_SESSION
+    integration_session: integration_session_t.IntegrationSession
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+SocketTokenRequest = typing.Annotated[
+    typing.Union[SocketRequestIntegrationSession],
+    serial_union_annotation(
+    named_type_path="sdk.sockets.SocketTokenRequest",
+        discriminator="type",
+        discriminator_map={
+            "integration_session": SocketRequestIntegrationSession,
+        },
+    ),
+]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.sockets.SocketTokenResponse",
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class SocketTokenResponse:
+    token: str
+# DO NOT MODIFY -- This file is generated by type_spec

{uncountablepythonsdk-0.0.122.dist-info → uncountablepythonsdk-0.0.123.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.122
+Version: 0.0.123
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{uncountablepythonsdk-0.0.122.dist-info → uncountablepythonsdk-0.0.123.dist-info}/RECORD

@@ -1,9 +1,11 @@
 docs/.gitignore,sha256=_ebkZUcwfvfnGEJ95rfj1lxoBNd6EE9ZvtOc7FsbfFE,7
-docs/conf.py,sha256=Qaw_Ys35RUUXKpFyGjiX120kABf6keZIq7iUdsUQxGY,2843
-docs/index.md,sha256=HOQ3H-hErtHlVJMQ-gZjWF_xj1U68Au4aHa_Rc-K8uk,363
+docs/conf.py,sha256=bNk-lXzCTltXz_ZyQmBWXjHa_wL_-YuvPb7yHTuCbZ8,2858
+docs/index.md,sha256=YHwBQmoVjIfJ5nXi4-JSAGkzy7IHDD_DugV-u9s7IrQ,3197
 docs/justfile,sha256=WymCEQ6W2A8Ak79iUPmecmuaUNN2htb7STUrz5K7ELE,273
-docs/quickstart.md,sha256=3GuJ0MB1O5kjlsrgAmdSkDq0rYqATrYy-tzEHDy8H-c,422
 docs/requirements.txt,sha256=Q5qvOf7nQa19R4kCWb_1DBhwW-Vtm3SAtZTPDR_aF9c,171
+docs/integration_examples/create_ingredient.md,sha256=bzTQ943YhINxa3HQylEA26rbAsjr6HvvN_HkVkrzUeA,1547
+docs/integration_examples/create_output.md,sha256=aDn2TjzKgY-HnxnvgsZS578cvajmHpF1y2HKkHfdtd4,2104
+docs/integration_examples/index.md,sha256=lVP6k79rGgdWPfEKM8oJvxeJsBKlpRJaZfrqn9lkiBc,73
 docs/static/logo_blue.png,sha256=SyYpMTVhhBbhF5Wl8lWaVwz-_p1MIR6dW6bVhufQRME,46708
 docs/static/favicons/android-chrome-192x192.png,sha256=XoF-AhD55JlSBDGsEPJKfT_VeXT-awhwKyZnxLhrwvk,1369
 docs/static/favicons/android-chrome-512x512.png,sha256=1S4xwY9YtJQ5ifFsZ-DOzssoyBYs0t9uwdOUmYx0Xso,3888
@@ -15,11 +17,13 @@ docs/static/favicons/manifest.json,sha256=6q_3nZkcg_x0xut4eE-xpdeMY1TydwiZIcbXlL
 docs/static/favicons/mstile-150x150.png,sha256=eAK4QdEofhdLtfmjuPTpnX3MJqYnvGXsHYUjlcQekyY,1035
 docs/static/favicons/safari-pinned-tab.svg,sha256=S84fRnz0ZxLnQrKtmmFZytiRyu1xLtMR_RVy5jmwU7k,1926
 examples/async_batch.py,sha256=tEyvgxk2uf681mKlN4TDuPMkb1OHyM9oO8pYW4A7HvM,1142
+examples/basic_auth.py,sha256=RU7dx_y5sWiS-wN70BXReWLwHoZ8TNmGh14e_JyG8tw,228
 examples/create_entity.py,sha256=t6WBZsWRDbWZgFCWXKGgKL5LAB6-38oaiNYGxMAa2No,686
 examples/create_ingredient_sdk.py,sha256=3Wte0MUH0-vOs6VtSLPIVQEmBVbR85u_qq0L9MmeP4Q,1054
 examples/download_files.py,sha256=rjv7EUgSw_W24_F5La-MljnIDQhbrvA7p2M-qPFbrXA,734
 examples/edit_recipe_inputs.py,sha256=mtk_oSkN-OT2hKkb1XKXrRiUaGYTJstXuOKyTR51Fjo,1663
 examples/invoke_uploader.py,sha256=rEvmVY5TjigN_-4PTQdkjY-bC5DrYMcJgquyZ4Tt5FM,748
+examples/oauth.py,sha256=QUmv4c27UDs3q98yigyA_Sm3hdK5qNfnDvxh7k06ZYg,213
 examples/set_recipe_metadata_file.py,sha256=cRVXGz4UN4aqnNrNSzyBmikYHpe63lMIuzOpMwD9EDU,1036
 examples/set_recipe_output_file_sdk.py,sha256=Lz1amqppnWTX83z-C090wCJ4hcKmCD3kb-4v0uBRi0Y,782
 examples/upload_files.py,sha256=qMaSvMSdTMPOOP55y1AwEurc0SOdZAMvEydlqJPsGpg,432
@@ -35,7 +39,7 @@ pkgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/argument_parser/__init__.py,sha256=EG3pwLEHTp-Qltd3lRnO4K22RiVrasePzKPDOfTPxFY,924
 pkgs/argument_parser/_is_enum.py,sha256=Gw6jJa8nBwYGqXwwCZbSnWL8Rvr5alkg5lSVAqXtOZM,257
-pkgs/argument_parser/_is_namedtuple.py,sha256=Rjc1bKanIPPogl3qG5JPBxglG1TqWYOo1nxxhBASQWY,265
+pkgs/argument_parser/_is_namedtuple.py,sha256=InCP2orqKbUYc4JsmE7ccri2EQPvLZeRijYPGqVSeXY,323
 pkgs/argument_parser/argument_parser.py,sha256=AjmLCNHcGMyXLojSpuKSYvIYE3u8tbg8rjv-yrhosQs,21077
 pkgs/argument_parser/case_convert.py,sha256=NuJLJUJRbyVb6_Slen4uqaStEHbcOS1d-hBBfDrrw-c,605
 pkgs/filesystem_utils/__init__.py,sha256=2a0d2rEPlEEYwhm3Wckny4VCp4ZS7JtYSXmwdwNCRjo,1332
@@ -84,7 +88,7 @@ pkgs/type_spec/actions_registry/emit_typescript.py,sha256=W1lI36ITdJ7MBf37wlTB7H
 pkgs/type_spec/parts/base.py.prepart,sha256=Xy8my5ol_Iu0hpQpvgsmqGLkGcMsLSg-cgjm4Yp-QI4,2369
 pkgs/type_spec/parts/base.ts.prepart,sha256=42-1_N_K04t4c6pE62V4wBw3bR5bgPxhmXUk__A7gAs,1002
 pkgs/type_spec/type_info/__main__.py,sha256=TLNvCHGcmaj_8Sj5bAQNpuNaaw2dpDzoFDWZds0V4Qo,1002
-pkgs/type_spec/type_info/emit_type_info.py,sha256=xRjZiwDDii4Bq8yVfcgE8YFechoKAcGmYXBk3Dq-K-s,15387
+pkgs/type_spec/type_info/emit_type_info.py,sha256=wuhdAJh7Nrdj1tFeiaavpwCdhlig5qZE1JuE8BMLYdE,15655
 pkgs/type_spec/ui_entry_actions/__init__.py,sha256=WiHE_BexOEZWbkkbD7EnFau1aMLNmfgQywG9PTQNCkw,135
 pkgs/type_spec/ui_entry_actions/generate_ui_entry_actions.py,sha256=65qUEp9zVcAsHEe3QjOTlPfLf45kH980fOXZXKNmOC8,9503
 pkgs/type_spec/value_spec/__init__.py,sha256=Z-grlcZtxAfEXhPHsK0nD7PFLGsv4eqvunaPN7_TA84,83
@@ -109,7 +113,7 @@ uncountable/integration/job.py,sha256=HFYA3YxqwyCvQLqXpMnKxp2IJUjFgjMsWVz_DTb_5e
 uncountable/integration/scan_profiles.py,sha256=RHBmPc5E10YZzf4cmglwrn2yAy0jHBhQ-P_GlAk2TeU,2919
 uncountable/integration/scheduler.py,sha256=KK-1XCr8Rxi8puaynb3H0BySvsDBJJaPcGumy49ZMB8,4864
 uncountable/integration/server.py,sha256=lL9zmzqkQRf7V1fBT20SvIy-7ryz5hFf7DF4QX4pj1E,4699
-uncountable/integration/telemetry.py,sha256=VunRaMC9ykPaxUE_s6SarQieKrGNtTSyAr9omc315OI,7419
+uncountable/integration/telemetry.py,sha256=usB82d1hVCoGaBUv2xM4grQN5WqHwVCASdgNJ1RoaPc,7588
 uncountable/integration/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uncountable/integration/db/connect.py,sha256=mE3bdV0huclH2iT_dXCQdRL4LkjIuf_myAR64RTWXEs,498
 uncountable/integration/db/session.py,sha256=96cGQXpe6IugBTdSsjdP0S5yhJ6toSmbVB6qhc3FJzE,693
@@ -141,7 +145,7 @@ uncountable/integration/queue_runner/datastore/model.py,sha256=8-RI5A2yPZVGBLWIN
 uncountable/integration/secret_retrieval/__init__.py,sha256=3QXVj35w8rRMxVvmmsViFYDi3lcb3g70incfalOEm6o,87
 uncountable/integration/secret_retrieval/retrieve_secret.py,sha256=LBEf18KHtXZxg-ZZ80stJ1vW39AWf0CQllP6pNu3Eq8,2994
 uncountable/integration/webhook_server/entrypoint.py,sha256=NQawXl_JCRojdVniS5RF7dobQQKW_Wy03bwy-uXknuA,3441
-uncountable/types/__init__.py,sha256=ubEQxcYFowfwzlbHf_zavI2EZOAm3sM5CZGfnAJRUMM,10271
+uncountable/types/__init__.py,sha256=bkleojXUnG9CvMaJCGiqsVk3eVTM0clOtCLvjXUx3L4,10415
 uncountable/types/async_batch.py,sha256=yCCWrrLQfxXVqZp-KskxLBNkNmuELdz4PJjx8ULppgs,662
 uncountable/types/async_batch_processor.py,sha256=h_8Snzt3lbEFlZAZFByt4Hg4dv2YlxMijHjTHjZ0aXY,22062
 uncountable/types/async_batch_t.py,sha256=JuswurXlYW38MfAXJ0UWb7hE2rmzFaHBAsNhRYAyMD4,3779
@@ -155,7 +159,7 @@ uncountable/types/calculations.py,sha256=fApOFpgBemt_t7IVneVR0VdI3X5EOxiG6Xhzr6R
 uncountable/types/calculations_t.py,sha256=pl-lhjyDQuj11Sf9g1-0BsSkN7Ez8UxDp8-KMQ_3enM,709
 uncountable/types/chemical_structure.py,sha256=ujyragaD26-QG5jgKnWhO7TN3N1V9b_04T2WhqNYxxo,281
 uncountable/types/chemical_structure_t.py,sha256=VFFyits_vx4t5L2euu_qFiSpsGJjURkDPr3ISnr3nPc,855
-uncountable/types/client_base.py,sha256=9osmz1wYM9PpqUSrWKHOYjwqNC6pOL6RVsIXIq_niW4,76886
+uncountable/types/client_base.py,sha256=Letfk7hK3OBX7vjqONbPytlQwGLTGsDijrLt0O4OPWk,76997
 uncountable/types/client_config.py,sha256=qLpHt4O_B098CyN6qQajoxZ2zjZ1DILXLUEGyyGP0TQ,280
 uncountable/types/client_config_t.py,sha256=yTFIYAitMrcc4oV9J-HADODS_Hwi45z-piz7rr7QT04,781
 uncountable/types/curves.py,sha256=QyEyC20jsG-LGKVx6miiF-w70vKMwNkILFBDIJ5Ok9g,345
@@ -184,6 +188,8 @@ uncountable/types/inputs.py,sha256=3ghg39_oiLF5HqWF_wNwYv4HMR1lrKLfeRLn5ptIGw4,4
 uncountable/types/inputs_t.py,sha256=eSVA7LNgLI3ja83GJm4sA9KhPICVV4zj2Dd4OhbuY9g,2158
 uncountable/types/integration_server.py,sha256=VonA8h8TGnVBiss5W8-K82lA01JQa7TLk0ubFo8iiBQ,364
 uncountable/types/integration_server_t.py,sha256=pgtoyuW6QvGRawidJZFB-WnOdwCE4OIoJAvGfussZKU,1304
+uncountable/types/integration_session.py,sha256=MVTtZa04INF4L8PxPjqz3l1Lse6Hze3IlYPs2bRSqE0,548
+uncountable/types/integration_session_t.py,sha256=HEfmPB6pt9GpgdaGKG0kgsJwq6W0Lid9Jy7Dzghhaic,1920
 uncountable/types/integrations.py,sha256=0fOhtbLIOl9w1GP9J3PTagRU8mjOKV48JNLLH3SJQP0,472
 uncountable/types/integrations_t.py,sha256=ihyhuMDKtJarQ19OppS0fYpJUYd8o5-w6YCDE440O-w,1871
 uncountable/types/job_definition.py,sha256=hYp5jPYLLYm3NKEqzQrQfXL0Ms5KgEQGTON13YWSPYk,1804
@@ -220,6 +226,8 @@ uncountable/types/response.py,sha256=SJTwjTxZGItGJJYPZ_T1zTooEbtR5ZA8GT_cf8aXfn8
 uncountable/types/response_t.py,sha256=EJwr5j9IZrtmyD4k8PxHSmTtHa470XkZCQYIpbpsJx0,728
 uncountable/types/secret_retrieval.py,sha256=poY_nuZBIjNu64Wa0x5Ytsmh3OdAxps2kzuDgv1sa_8,571
 uncountable/types/secret_retrieval_t.py,sha256=igWrOW_CwRvAE7BHIHVJojBwgcAG05Pqup8D45Sb0F4,2342
+uncountable/types/sockets.py,sha256=avkDlKqvvA9W492N9jrfYbnQlVWHN94hne39RM0cUxM,552
+uncountable/types/sockets_t.py,sha256=EC3qRIegdIOcIITC1Y_O79xfo-FSevxsM_IhJ-Up_Bw,2224
 uncountable/types/units.py,sha256=yxuddayiE8cnzrjQiIsURisWc-Vm1F37uyS3fjM--Ao,254
 uncountable/types/units_t.py,sha256=d62vY2ETqIgMHASw_IcREwDDqKAqI-vPnoBOqzMt4-o,704
 uncountable/types/users.py,sha256=R-bFIh07mMl6HyxP8hKmlT-QMbBXZPZ7mVuOIeOlCsg,254
@@ -240,7 +248,7 @@ uncountable/types/api/entity/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8A
 uncountable/types/api/entity/create_entities.py,sha256=cCDEra2SHvGWvz7nIxxMDSQN6OWrHMTT0JSomWUesto,1794
 uncountable/types/api/entity/create_entity.py,sha256=urT6C7iGAa7_rCv9Wcz6GM_lKg1tP55E__rjNkj-Rjc,1879
 uncountable/types/api/entity/create_or_update_entity.py,sha256=cxjJIcZTKOg8Y5kGzctYKayfnr8BNZDOM5YfI4dBSf0,1532
-uncountable/types/api/entity/export_entities.py,sha256=zz_4P6bQAt7gU2o2to9zUh0HHLQKaxLkbFGfbgY3KVk,1395
+uncountable/types/api/entity/export_entities.py,sha256=KGAkzHXbY28v7vcO_XyHVKQ-RVryI5dlYx4HdlYnBXw,1814
 uncountable/types/api/entity/get_entities_data.py,sha256=hu0UfkU4PTyv3_CBZ7YmR8L8BKMq8hx6zH43XtUm16E,1616
 uncountable/types/api/entity/grant_entity_permissions.py,sha256=4CvVIMvpdok8K1Bh6wMlwuUmoeP_-nL9y2GCEM6uAhY,1536
 uncountable/types/api/entity/list_entities.py,sha256=LLc_QRH2LI7qPamxwF8DAPJCnfDo1Nw_0VGNDl6CMXI,2139
@@ -326,7 +334,7 @@ uncountable/types/api/uploader/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr
 uncountable/types/api/uploader/invoke_uploader.py,sha256=Bj7Dq4A90k00suacwk3bLA_dCb2aovS1kAbVam2AQnM,1395
 uncountable/types/api/user/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/user/get_current_user_info.py,sha256=Avqi_RXtRgbefrT_dwJ9MrO6eDNSSa_Nu650FSuESlg,1109
-uncountablepythonsdk-0.0.122.dist-info/METADATA,sha256=KCzmpzYEmy6LpOZxLn9tvAVP2Q7H3UE5KeRynwvn9rM,2174
-uncountablepythonsdk-0.0.122.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-uncountablepythonsdk-0.0.122.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
-uncountablepythonsdk-0.0.122.dist-info/RECORD,,
+uncountablepythonsdk-0.0.123.dist-info/METADATA,sha256=c7NEs2mALBXTpQlBv3lF7A8gkSNJ8VlC0EO2rGz-RyI,2174
+uncountablepythonsdk-0.0.123.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+uncountablepythonsdk-0.0.123.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
+uncountablepythonsdk-0.0.123.dist-info/RECORD,,

docs/quickstart.md

@@ -1,19 +0,0 @@
-# Quickstart
-
-## Installation
-
-Install from PyPI:
-
-```{code-block} bash
-pip install UncountablePythonSDK
-```
-
-## Available SDK methods
-See the following class for a reference for the available python sdk methods. Then see the example in the next section on how to setup and call these methods.
-[](uncountable.types.client_base.ClientMethods)
-
-## Run a simple example
-
-```{literalinclude} ../examples/create_entity.py
-```
-