UncountablePythonSDK 0.0.50__tar.gz → 0.0.52__tar.gz

{uncountablepythonsdk-0.0.50/UncountablePythonSDK.egg-info → uncountablepythonsdk-0.0.52}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.50
+Version: 0.0.52
 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.50 → uncountablepythonsdk-0.0.52/UncountablePythonSDK.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.50
+Version: 0.0.52
 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.50 → uncountablepythonsdk-0.0.52}/docs/requirements.txt

@@ -1,7 +1,7 @@
-furo==2024.7.18
-myst-parser==3.0.1
+furo==2024.8.6
+myst-parser==4.0.0
 sphinx-autoapi==3.2.0
 sphinx-copybutton==0.5.2
 Sphinx==8.0.0
-sphinx_design==0.6.0
+sphinx_design==0.6.1
 sphinx-favicon==1.0.1

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/integration/construct_client.py

@@ -1,34 +1,32 @@
-import os
-
 from uncountable.core import AuthDetailsApiKey, Client
 from uncountable.core.client import ClientConfig
-from uncountable.core.types import AuthDetailsAll
+from uncountable.core.types import AuthDetailsAll, AuthDetailsOAuth
+from uncountable.integration.secret_retrieval.retrieve_secret import retrieve_secret
 from uncountable.integration.telemetry import JobLogger
 from uncountable.types.job_definition_t import (
-    AuthRetrievalEnv,
+    AuthRetrievalBasic,
+    AuthRetrievalOAuth,
     ProfileMetadata,
 )
 
 
-def _get_env_var(name: str) -> str:
-    value = os.getenv(name)
-    if value is None:
-        raise Exception(f"environment variable {name} is missing")
-    return value
-
-
 def _construct_auth_details(profile_meta: ProfileMetadata) -> AuthDetailsAll:
     match profile_meta.auth_retrieval:
-        case AuthRetrievalEnv():
-            api_id = _get_env_var(f"UNC_PROFILE_{profile_meta.name.upper()}_API_ID")
-            api_secret_key = _get_env_var(
-                f"UNC_PROFILE_{profile_meta.name.upper()}_API_SECRET_KEY"
+        case AuthRetrievalOAuth():
+            refresh_token = retrieve_secret(
+                profile_meta.auth_retrieval.refresh_token_secret,
+                profile_metadata=profile_meta,
+            )
+            return AuthDetailsOAuth(refresh_token=refresh_token)
+        case AuthRetrievalBasic():
+            api_id = retrieve_secret(
+                profile_meta.auth_retrieval.api_id_secret, profile_metadata=profile_meta
+            )
+            api_key = retrieve_secret(
+                profile_meta.auth_retrieval.api_key_secret, profile_metadata=profile_meta
             )
 
-            assert api_id is not None
-            assert api_secret_key is not None
-
-            return AuthDetailsApiKey(api_id=api_id, api_secret_key=api_secret_key)
+            return AuthDetailsApiKey(api_id=api_id, api_secret_key=api_key)
 
 
 def _construct_client_config(

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/integration/secret_retrieval/retrieve_secret.py

@@ -1,5 +1,10 @@
+import base64
+import functools
+import json
 import os
 
+import boto3
+
 from uncountable.types.job_definition_t import ProfileMetadata
 from uncountable.types.secret_retrieval_t import (
     SecretRetrieval,
@@ -22,6 +27,25 @@ class SecretRetrievalError(BaseException):
         return f"{self.secret_retrieval.type} secret retrieval failed{append_message}"
 
 
+@functools.cache
+def _get_aws_secret(*, secret_name: str, region_name: str, sub_key: str | None) -> str:
+    client = boto3.client("secretsmanager", region_name=region_name)
+    response = client.get_secret_value(SecretId=secret_name)
+
+    if "SecretString" in response:
+        secret = response["SecretString"]
+    else:
+        secret = base64.b64decode(response["SecretBinary"])
+
+    value = json.loads(secret)
+
+    if sub_key is not None:
+        assert isinstance(value, dict)
+        return str(value[sub_key])
+    else:
+        return str(value)
+
+
 def retrieve_secret(
     secret_retrieval: SecretRetrieval, profile_metadata: ProfileMetadata
 ) -> str:
@@ -37,4 +61,11 @@ def retrieve_secret(
                 )
             return secret
         case SecretRetrievalAWS():
-            raise NotImplementedError("aws secret retrieval not yet implemented")
+            try:
+                return _get_aws_secret(
+                    secret_name=secret_retrieval.secret_name,
+                    region_name=secret_retrieval.region,
+                    sub_key=secret_retrieval.sub_key,
+                )
+            except Exception as e:
+                raise SecretRetrievalError(secret_retrieval) from e

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/integration/server.py

@@ -11,6 +11,7 @@ from apscheduler.triggers.cron import CronTrigger
 from sqlalchemy.engine.base import Engine
 
 from uncountable.integration.cron import CronJobArgs, cron_job_executor
+from uncountable.integration.telemetry import Logger
 from uncountable.types import base_t
 from uncountable.types.client_config_t import ClientConfigOptions
 from uncountable.types.job_definition_t import (
@@ -26,6 +27,7 @@ _MAX_APSCHEDULER_CONCURRENT_JOBS = 1
 class IntegrationServer:
     _scheduler: BaseScheduler
     _engine: Engine
+    _server_logger: Logger
 
     def __init__(self, engine: Engine) -> None:
         self._engine = engine
@@ -34,6 +36,7 @@ class IntegrationServer:
             jobstores={"default": SQLAlchemyJobStore(engine=engine)},
             executors={"default": ThreadPoolExecutor(_MAX_APSCHEDULER_CONCURRENT_JOBS)},
         )
+        self._server_logger = Logger()
 
     def register_profile(
         self,
@@ -59,7 +62,14 @@ class IntegrationServer:
                             definition=job_defn, profile_metadata=profile_metadata
                         )
                     )
-                    existing_job = self._scheduler.get_job(job_defn.id)
+                    try:
+                        existing_job = self._scheduler.get_job(job_defn.id)
+                    except ValueError as e:
+                        self._server_logger.log_warning(
+                            f"could not reconstitute job {job_defn.id}: {e}"
+                        )
+                        self._scheduler.remove_job(job_defn.id)
+                        existing_job = None
                     if existing_job is not None:
                         existing_job.modify(
                             name=job_defn.name,

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/integration/telemetry.py

@@ -49,10 +49,39 @@ class LogSeverity(StrEnum):
     ERROR = "Error"
 
 
-class JobLogger:
+class Logger:
     current_span_id: int | None = None
     current_trace_id: int | None = None
 
+    def _patch_attributes(self, attributes: Attributes | None) -> Attributes:
+        return attributes or {}
+
+    def _emit_log(
+        self, message: str, *, severity: LogSeverity, attributes: Attributes | None
+    ) -> None:
+        log_record = LogRecord(
+            body=message,
+            severity_text=severity,
+            timestamp=time.time_ns(),
+            attributes=self._patch_attributes(attributes),
+            span_id=self.current_span_id,
+            trace_id=self.current_trace_id,
+        )
+        log_file: TextIO = sys.stderr if severity == LogSeverity.ERROR else sys.stdout
+        log_file.write(log_record.to_json())
+        log_file.flush()
+
+    def log_info(self, message: str, *, attributes: Attributes | None = None) -> None:
+        self._emit_log(message=message, severity=LogSeverity.INFO, attributes=attributes)
+
+    def log_warning(self, message: str, *, attributes: Attributes | None = None) -> None:
+        self._emit_log(message=message, severity=LogSeverity.WARN, attributes=attributes)
+
+    def log_error(self, message: str, *, attributes: Attributes | None = None) -> None:
+        self._emit_log(message=message, severity=LogSeverity.ERROR, attributes=attributes)
+
+
+class JobLogger(Logger):
     def __init__(
         self,
         *,
@@ -104,27 +133,3 @@ class JobLogger:
             self.current_span_id = span.get_span_context().span_id
             self.current_trace_id = span.get_span_context().trace_id
             yield self
-
-    def _emit_log(
-        self, message: str, *, severity: LogSeverity, attributes: Attributes | None
-    ) -> None:
-        log_record = LogRecord(
-            body=message,
-            severity_text=severity,
-            timestamp=time.time_ns(),
-            attributes=self._patch_attributes(attributes),
-            span_id=self.current_span_id,
-            trace_id=self.current_trace_id,
-        )
-        log_file: TextIO = sys.stderr if severity == LogSeverity.ERROR else sys.stdout
-        log_file.write(log_record.to_json())
-        log_file.flush()
-
-    def log_info(self, message: str, *, attributes: Attributes | None = None) -> None:
-        self._emit_log(message=message, severity=LogSeverity.INFO, attributes=attributes)
-
-    def log_warning(self, message: str, *, attributes: Attributes | None = None) -> None:
-        self._emit_log(message=message, severity=LogSeverity.WARN, attributes=attributes)
-
-    def log_error(self, message: str, *, attributes: Attributes | None = None) -> None:
-        self._emit_log(message=message, severity=LogSeverity.ERROR, attributes=attributes)

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/types/api/entity/create_entities.py

@@ -34,7 +34,7 @@ class EntityToCreate:
 @dataclasses.dataclass(kw_only=True)
 class Arguments:
     definition_id: base_t.ObjectId
-    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS]]
+    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS], typing.Literal[entity_t.EntityType.GOAL]]
     entities_to_create: list[EntityToCreate]
 
 

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/types/api/entity/create_entity.py

@@ -40,7 +40,7 @@ class EntityFieldInitialValue:
 @dataclasses.dataclass(kw_only=True)
 class Arguments:
     definition_id: base_t.ObjectId
-    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS]]
+    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS], typing.Literal[entity_t.EntityType.GOAL]]
     field_values: typing.Optional[typing.Optional[list[field_values_t.FieldRefNameValue]]] = None
 
 

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/types/client_base.py

@@ -235,7 +235,7 @@ class ClientMethods(ABC):
         self,
         *,
         definition_id: base_t.ObjectId,
-        entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS]],
+        entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS], typing.Literal[entity_t.EntityType.GOAL]],
         entities_to_create: list[create_entities_t.EntityToCreate],
     ) -> create_entities_t.Data:
         """Creates new Uncountable entities
@@ -260,7 +260,7 @@ class ClientMethods(ABC):
         self,
         *,
         definition_id: base_t.ObjectId,
-        entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS]],
+        entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK], typing.Literal[entity_t.EntityType.SPECS], typing.Literal[entity_t.EntityType.GOAL]],
         field_values: typing.Optional[typing.Optional[list[field_values_t.FieldRefNameValue]]] = None,
     ) -> create_entity_t.Data:
         """Creates a new Uncountable entity

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/types/job_definition.py

@@ -21,7 +21,8 @@ from .job_definition_t import JobDefinitionBase as JobDefinitionBase
 from .job_definition_t import CronJobDefinition as CronJobDefinition
 from .job_definition_t import JobDefinition as JobDefinition
 from .job_definition_t import AuthRetrievalBase as AuthRetrievalBase
-from .job_definition_t import AuthRetrievalEnv as AuthRetrievalEnv
+from .job_definition_t import AuthRetrievalOAuth as AuthRetrievalOAuth
+from .job_definition_t import AuthRetrievalBasic as AuthRetrievalBasic
 from .job_definition_t import AuthRetrieval as AuthRetrieval
 from .job_definition_t import ProfileDefinition as ProfileDefinition
 from .job_definition_t import ProfileMetadata as ProfileMetadata

{uncountablepythonsdk-0.0.50 → uncountablepythonsdk-0.0.52}/uncountable/types/job_definition_t.py

@@ -18,7 +18,8 @@ from . import secret_retrieval_t
 __all__: list[str] = [
     "AuthRetrieval",
     "AuthRetrievalBase",
-    "AuthRetrievalEnv",
+    "AuthRetrievalBasic",
+    "AuthRetrievalOAuth",
     "AuthRetrievalType",
     "CronJobDefinition",
     "GenericUploadDataSource",
@@ -54,7 +55,8 @@ class JobExecutorType(StrEnum):
 
 # DO NOT MODIFY -- This file is generated by type_spec
 class AuthRetrievalType(StrEnum):
-    ENV = "env"
+    OAUTH = "oauth"
+    BASIC = "basic"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
@@ -162,7 +164,7 @@ class JobDefinitionBase:
     id: str
     name: str
     executor: JobExecutor
-    enabled: bool = False
+    enabled: bool = True
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
@@ -198,17 +200,30 @@ class AuthRetrievalBase:
     parse_require={"type"},
 )
 @dataclasses.dataclass(kw_only=True)
-class AuthRetrievalEnv(AuthRetrievalBase):
-    type: typing.Literal[AuthRetrievalType.ENV] = AuthRetrievalType.ENV
+class AuthRetrievalOAuth(AuthRetrievalBase):
+    type: typing.Literal[AuthRetrievalType.OAUTH] = AuthRetrievalType.OAUTH
+    refresh_token_secret: secret_retrieval_t.SecretRetrieval
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclasses.dataclass(kw_only=True)
+class AuthRetrievalBasic(AuthRetrievalBase):
+    type: typing.Literal[AuthRetrievalType.BASIC] = AuthRetrievalType.BASIC
+    api_id_secret: secret_retrieval_t.SecretRetrieval
+    api_key_secret: secret_retrieval_t.SecretRetrieval
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 AuthRetrieval = typing.Annotated[
-    typing.Union[AuthRetrievalEnv],
+    typing.Union[AuthRetrievalOAuth, AuthRetrievalBasic],
     serial_union_annotation(
         discriminator="type",
         discriminator_map={
-            "env": AuthRetrievalEnv,
+            "oauth": AuthRetrievalOAuth,
+            "basic": AuthRetrievalBasic,
         },
     ),
 ]