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

docs/conf.py

@@ -8,6 +8,11 @@
 
 import datetime
 
+from docutils import nodes  # type: ignore[import-untyped]
+from sphinx.addnodes import pending_xref  # type: ignore[import-not-found]
+from sphinx.application import Sphinx  # type: ignore[import-not-found]
+from sphinx.environment import BuildEnvironment  # type: ignore[import-not-found]
+
 project = "Uncountable SDK"
 copyright = f"{datetime.datetime.now(tz=datetime.UTC).date().year}, Uncountable Inc"
 author = "Uncountable Inc"
@@ -27,17 +32,18 @@ myst_enable_extensions = ["fieldlist", "deflist"]
 autoapi_dirs = ["../uncountable"]
 autoapi_options = [
     "members",
+    "inherited-members",
     "undoc-members",
-    "show-inheritance",
-    "show-module-summary",
-    "imported-members",
 ]
+autoapi_root = "api"
 autoapi_ignore = ["*integration*"]
 autodoc_typehints = "description"
+autoapi_member_order = "groupwise"
+autoapi_own_page_level = "class"
 
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-
+python_use_unqualified_type_names = True
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
@@ -55,3 +61,25 @@ favicons = [
     "favicons/mstile-150x150.png",
     "favicons/safari-pinned-tab.svg",
 ]
+
+
+def _hook_missing_reference(
+    _app: Sphinx, _env: BuildEnvironment, node: pending_xref, contnode: nodes.Text
+) -> nodes.reference | None:
+    """
+    Manually resolve reference when autoapi reference resolution fails.
+    This is necessary because autoapi does not fully support type aliases.
+    """
+    target = node.get("reftarget", "")
+    if not target.startswith("uncountable"):
+        return None
+    module, name = target.rsplit(".", 1)
+    return nodes.reference(
+        text=name if python_use_unqualified_type_names else target,
+        children=[contnode],
+        refuri=f"/{autoapi_root}/{module.replace('.', '/')}/#{target}",
+    )
+
+
+def setup(app: Sphinx) -> None:
+    app.connect("missing-reference", _hook_missing_reference)

docs/index.md

@@ -7,7 +7,10 @@
 
 ```{toctree}
 :maxdepth: 2
+:hidden:
 
 quickstart
+Available SDK Methods <api/uncountable/core/client/Client>
+SDK Reference <api/uncountable/index>
 ```
 

docs/requirements.txt

@@ -1,4 +1,4 @@
-furo==2024.8.6
+furo==2025.7.19
 myst-parser==4.0.0
 sphinx-autoapi==3.6.0
 sphinx-copybutton==0.5.2
@@ -6,3 +6,4 @@ Sphinx==8.2.0
 sphinx_design==0.6.1
 sphinx-favicon==1.0.1
 astroid==3.3.8
+docutils==0.21.2

examples/integration-server/jobs/materials_auto/example_http.py

@@ -4,6 +4,7 @@ from uncountable.integration.http_server import (
     GenericHttpRequest,
     GenericHttpResponse,
 )
+from uncountable.integration.http_server.types import HttpException
 from uncountable.integration.job import CustomHttpJob, register_job
 from uncountable.types import job_definition_t
 
@@ -14,6 +15,9 @@ class ExampleWebhookPayload:
     message: str
 
 
+_EXPECTED_USER_ID = 1
+
+
 @register_job
 class HttpExample(CustomHttpJob):
     @staticmethod
@@ -23,7 +27,15 @@ class HttpExample(CustomHttpJob):
         job_definition: job_definition_t.HttpJobDefinitionBase,  # noqa: ARG004
         profile_meta: job_definition_t.ProfileMetadata,  # noqa: ARG004
     ) -> None:
-        return None
+        if (
+            CustomHttpJob.get_validated_oauth_request_user_id(
+                request=request, profile_metadata=profile_meta
+            )
+            != _EXPECTED_USER_ID
+        ):
+            raise HttpException(
+                message="unauthorized; invalid oauth token", error_code=401
+            )
 
     @staticmethod
     def handle_request(

uncountable/integration/job.py

@@ -12,6 +12,7 @@ from uncountable.core.async_batch import AsyncBatchProcessor
 from uncountable.core.client import Client
 from uncountable.core.environment import get_local_admin_server_port
 from uncountable.core.file_upload import FileUpload
+from uncountable.core.types import AuthDetailsOAuth
 from uncountable.integration.http_server import (
     GenericHttpRequest,
     GenericHttpResponse,
@@ -93,6 +94,19 @@ class WebhookResponse:
     pass
 
 
+class _RequestValidatorClient(Client):
+    def __init__(self, *, base_url: str, oauth_bearer_token: str):
+        super().__init__(
+            base_url=base_url,
+            auth_details=AuthDetailsOAuth(refresh_token=""),
+            config=None,
+        )
+        self._oauth_bearer_token = oauth_bearer_token
+
+    def _get_oauth_bearer_token(self, *, oauth_details: AuthDetailsOAuth) -> str:
+        return self._oauth_bearer_token
+
+
 class CustomHttpJob(Job[GenericHttpRequest]):
     @property
     def payload_type(self) -> type[GenericHttpRequest]:
@@ -112,6 +126,24 @@ class CustomHttpJob(Job[GenericHttpRequest]):
         """
         ...
 
+    @staticmethod
+    def get_validated_oauth_request_user_id(
+        *, profile_metadata: ProfileMetadata, request: GenericHttpRequest
+    ) -> base_t.ObjectId:
+        token = request.headers.get("Authorization", "").replace("Bearer ", "")
+        if token == "":
+            raise HttpException(
+                message="unauthorized; no bearer token in request", error_code=401
+            )
+        return (
+            _RequestValidatorClient(
+                base_url=profile_metadata.base_url,
+                oauth_bearer_token=token,
+            )
+            .get_current_user_info()
+            .user_id
+        )
+
     @staticmethod
     @abstractmethod
     def handle_request(

uncountable/types/exports_t.py

@@ -30,4 +30,5 @@ class ListingExportUserTimezone:
 class ExportType(StrEnum):
     EXCEL = "excel"
     PDF = "pdf"
+    JSON = "json"
 # DO NOT MODIFY -- This file is generated by type_spec

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.121
+Version: 0.0.122
 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.121.dist-info → uncountablepythonsdk-0.0.122.dist-info}/RECORD

@@ -1,9 +1,9 @@
 docs/.gitignore,sha256=_ebkZUcwfvfnGEJ95rfj1lxoBNd6EE9ZvtOc7FsbfFE,7
-docs/conf.py,sha256=B3WBkqPxlf3xYHXCy91599SJ75G2eGrDs-K_RbsxT5k,1725
-docs/index.md,sha256=eEdirX_Ds6ICTRtIS5iT4irCquHcQyKN7E4M5QP9T8A,257
+docs/conf.py,sha256=Qaw_Ys35RUUXKpFyGjiX120kABf6keZIq7iUdsUQxGY,2843
+docs/index.md,sha256=HOQ3H-hErtHlVJMQ-gZjWF_xj1U68Au4aHa_Rc-K8uk,363
 docs/justfile,sha256=WymCEQ6W2A8Ak79iUPmecmuaUNN2htb7STUrz5K7ELE,273
 docs/quickstart.md,sha256=3GuJ0MB1O5kjlsrgAmdSkDq0rYqATrYy-tzEHDy8H-c,422
-docs/requirements.txt,sha256=IBoo8nKwyuZXoaSX7XOYRJvfT6VjwJPXz49eZvcZGuY,153
+docs/requirements.txt,sha256=Q5qvOf7nQa19R4kCWb_1DBhwW-Vtm3SAtZTPDR_aF9c,171
 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
@@ -26,7 +26,7 @@ examples/upload_files.py,sha256=qMaSvMSdTMPOOP55y1AwEurc0SOdZAMvEydlqJPsGpg,432
 examples/integration-server/pyproject.toml,sha256=-ZZ1R3B-Pf-F6gQX0-Me6u3G9cVW2B2_eechemCe7_4,9149
 examples/integration-server/jobs/materials_auto/concurrent_cron.py,sha256=xsK3H9ZEaniedC2nJUB0rqOcFI8y-ojfl_nLSJb9AMM,312
 examples/integration-server/jobs/materials_auto/example_cron.py,sha256=spUMiiTEFaepbVXecjD_4aEEfqEtZGGZuWTKs9J6Xcw,736
-examples/integration-server/jobs/materials_auto/example_http.py,sha256=eVq-Fss_AhmztxOMqqO-GYGF3KvPt1O5HbNwwC2arh8,1037
+examples/integration-server/jobs/materials_auto/example_http.py,sha256=eIL46ElWo8SKY7W5JWWkwZk6Qo7KRd9EJBxfy7YQ_sE,1429
 examples/integration-server/jobs/materials_auto/example_instrument.py,sha256=czJF3qBFay1S8fuESOvmkvBv1wCtZGAlHjwvCyYr-Mw,2336
 examples/integration-server/jobs/materials_auto/example_runsheet_wh.py,sha256=_wILTnbzzLf9zrcQb_KQKytxxcya1ej6MqQnoUSS4fA,1180
 examples/integration-server/jobs/materials_auto/example_wh.py,sha256=PN-skP27yJwDZboWk5g5EZEc3AKfVayQLfnopjsDKJc,659
@@ -105,7 +105,7 @@ uncountable/integration/cli.py,sha256=eshJ0lv4u00UOFrlkCwamE8NaxX1qN2q79wCJcsFrJ
 uncountable/integration/construct_client.py,sha256=I53mGcdS88hba3HFwgXmWQaTd1d5u0jWNSwyc_vlVsQ,1937
 uncountable/integration/cron.py,sha256=6eH-kIs3sdYPCyb62_L2M7U_uQTdMTdwY5hreEJb0hw,887
 uncountable/integration/entrypoint.py,sha256=BHOYPQgKvZE6HG8Rv15MkdYl8lRkvfDgv1OdLo0oQ9Q,433
-uncountable/integration/job.py,sha256=X8mNoy01Q6h26eNuPi50XwV6YLgaqYCGWt2PFDEddZU,7111
+uncountable/integration/job.py,sha256=HFYA3YxqwyCvQLqXpMnKxp2IJUjFgjMsWVz_DTb_5eo,8229
 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
@@ -167,7 +167,7 @@ uncountable/types/entity_t.py,sha256=cULJs6qZAWnN4U8pZadcsf9A5KmlLTkIlwW_sQf627I
 uncountable/types/experiment_groups.py,sha256=qUpFOx1AKgzaT_4khCOv5Xs6jwiQGbvHH-GUh3v1nv4,288
 uncountable/types/experiment_groups_t.py,sha256=29Ct-WPejpYMuGfnFfOoosU9iSfjzxpabpBX6oTPFUA,761
 uncountable/types/exports.py,sha256=VMmxUO2PpV1Y63hZ2AnVor4H-B6aswJ7YpSru_u89lU,334
-uncountable/types/exports_t.py,sha256=der2gk1YL5XjWTrqsLD2KNynXA_z7IzmvphOfvGT19M,894
+uncountable/types/exports_t.py,sha256=p_ub9Ltk6bGE4CCe07Mfz7y4-uDMCIo5_jZr1l55zsE,912
 uncountable/types/field_values.py,sha256=iG4TvITLnlz023GuhFrlDwXB7oov5DPpAs_FBaMaJR8,1713
 uncountable/types/field_values_t.py,sha256=Br2D2dibU9avbomfkaXHXw1ineUcIkATBbEm0eZm1SE,10076
 uncountable/types/fields.py,sha256=M0_ZZr0QdNLXkdHAGo5mfU90kEtHedCSKrcod-FG30Y,245
@@ -326,7 +326,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.121.dist-info/METADATA,sha256=t53LhUUiQvTlHYZC-eX4VQU2KiyBCglI5Ywlmsh_qAk,2174
-uncountablepythonsdk-0.0.121.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-uncountablepythonsdk-0.0.121.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
-uncountablepythonsdk-0.0.121.dist-info/RECORD,,
+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,,