rapidata 2.17.1__py3-none-any.whl → 2.19.0__py3-none-any.whl

rapidata/api_client_README.md

@@ -162,8 +162,10 @@ Class | Method | HTTP request | Description
 *OrderApi* | [**orders_public_get**](rapidata/api_client/docs/OrderApi.md#orders_public_get) | **GET** /orders/public | Retrieves orders that are public and can be cloned by any user.
 *PipelineApi* | [**pipeline_id_workflow_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_artifact_id_put) | **PUT** /pipeline/{id}/workflow/{artifactId} | Updates the workflow configuration for a pipeline.
 *PipelineApi* | [**pipeline_id_workflow_config_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_config_artifact_id_put) | **PUT** /pipeline/{id}/workflow-config/{artifactId} | Updates the workflow configuration for a pipeline.
+*PipelineApi* | [**pipeline_id_workflow_config_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_config_put) | **PUT** /pipeline/{id}/workflow-config | Updates the workflow configuration for a pipeline.
 *PipelineApi* | [**pipeline_pipeline_id_campaign_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_artifact_id_put) | **PUT** /pipeline/{pipelineId}/campaign/{artifactId} | Updates a specific campaign for a pipeline.
 *PipelineApi* | [**pipeline_pipeline_id_campaign_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_post) | **POST** /pipeline/{pipelineId}/campaign | Adds a campaign to a pipeline.
+*PipelineApi* | [**pipeline_pipeline_id_campaign_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_put) | **PUT** /pipeline/{pipelineId}/campaign | Updates a specific campaign for a pipeline.
 *PipelineApi* | [**pipeline_pipeline_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_get) | **GET** /pipeline/{pipelineId} | Gets a pipeline by its id.
 *PipelineApi* | [**pipeline_pipeline_id_preliminary_download_post**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_preliminary_download_post) | **POST** /pipeline/{pipelineId}/preliminary-download | Initiates a preliminary download of the pipeline.
 *PipelineApi* | [**pipeline_preliminary_download_preliminary_download_id_get**](rapidata/api_client/docs/PipelineApi.md#pipeline_preliminary_download_preliminary_download_id_get) | **GET** /pipeline/preliminary-download/{preliminaryDownloadId} | Gets the preliminary download.
@@ -223,7 +225,6 @@ Class | Method | HTTP request | Description
  - [AddCampaignArtifactResult](rapidata/api_client/docs/AddCampaignArtifactResult.md)
  - [AddCampaignModel](rapidata/api_client/docs/AddCampaignModel.md)
  - [AddUserResponseResult](rapidata/api_client/docs/AddUserResponseResult.md)
- - [AddUserResponseResultValidationTruth](rapidata/api_client/docs/AddUserResponseResultValidationTruth.md)
  - [AddValidationRapidModel](rapidata/api_client/docs/AddValidationRapidModel.md)
  - [AddValidationRapidModelPayload](rapidata/api_client/docs/AddValidationRapidModelPayload.md)
  - [AddValidationRapidModelTruth](rapidata/api_client/docs/AddValidationRapidModelTruth.md)
@@ -353,8 +354,11 @@ Class | Method | HTTP request | Description
  - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
  - [GetSimpleWorkflowResultsResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResult.md)
  - [GetSimpleWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResultPagedResult.md)
- - [GetValidationRapidsQuery](rapidata/api_client/docs/GetValidationRapidsQuery.md)
- - [GetValidationRapidsQueryPagedResult](rapidata/api_client/docs/GetValidationRapidsQueryPagedResult.md)
+ - [GetValidationRapidsResult](rapidata/api_client/docs/GetValidationRapidsResult.md)
+ - [GetValidationRapidsResultAsset](rapidata/api_client/docs/GetValidationRapidsResultAsset.md)
+ - [GetValidationRapidsResultPagedResult](rapidata/api_client/docs/GetValidationRapidsResultPagedResult.md)
+ - [GetValidationRapidsResultPayload](rapidata/api_client/docs/GetValidationRapidsResultPayload.md)
+ - [GetValidationRapidsResultTruth](rapidata/api_client/docs/GetValidationRapidsResultTruth.md)
  - [GetValidationSetByIdResult](rapidata/api_client/docs/GetValidationSetByIdResult.md)
  - [GetWorkflowByIdResult](rapidata/api_client/docs/GetWorkflowByIdResult.md)
  - [GetWorkflowByIdResultWorkflow](rapidata/api_client/docs/GetWorkflowByIdResultWorkflow.md)
@@ -395,10 +399,12 @@ Class | Method | HTTP request | Description
  - [NewUserFilterModel](rapidata/api_client/docs/NewUserFilterModel.md)
  - [NewsletterModel](rapidata/api_client/docs/NewsletterModel.md)
  - [NotAvailableYetResult](rapidata/api_client/docs/NotAvailableYetResult.md)
+ - [NotUserFilterModel](rapidata/api_client/docs/NotUserFilterModel.md)
  - [NullAssetModel](rapidata/api_client/docs/NullAssetModel.md)
  - [OnlinePairMakerConfig](rapidata/api_client/docs/OnlinePairMakerConfig.md)
  - [OnlinePairMakerConfigModel](rapidata/api_client/docs/OnlinePairMakerConfigModel.md)
  - [OnlinePairMakerInformation](rapidata/api_client/docs/OnlinePairMakerInformation.md)
+ - [OrUserFilterModel](rapidata/api_client/docs/OrUserFilterModel.md)
  - [OrderModel](rapidata/api_client/docs/OrderModel.md)
  - [OrderModelPagedResult](rapidata/api_client/docs/OrderModelPagedResult.md)
  - [OrderState](rapidata/api_client/docs/OrderState.md)
@@ -421,9 +427,7 @@ Class | Method | HTTP request | Description
  - [PublicTextMetadataInput](rapidata/api_client/docs/PublicTextMetadataInput.md)
  - [QueryModel](rapidata/api_client/docs/QueryModel.md)
  - [QueryValidationRapidsResult](rapidata/api_client/docs/QueryValidationRapidsResult.md)
- - [QueryValidationRapidsResultAsset](rapidata/api_client/docs/QueryValidationRapidsResultAsset.md)
  - [QueryValidationRapidsResultPagedResult](rapidata/api_client/docs/QueryValidationRapidsResultPagedResult.md)
- - [QueryValidationRapidsResultPayload](rapidata/api_client/docs/QueryValidationRapidsResultPayload.md)
  - [QueryWorkflowsModel](rapidata/api_client/docs/QueryWorkflowsModel.md)
  - [RapidIssue](rapidata/api_client/docs/RapidIssue.md)
  - [RapidResponse](rapidata/api_client/docs/RapidResponse.md)

rapidata/rapidata_client/__init__.py

@@ -40,6 +40,8 @@ from .filter import (
     CustomFilter,
     AgeGroup,
     Gender,
+    NotFilter,
+    OrFilter,
 )
 
 from .validation import Box

rapidata/rapidata_client/filter/__init__.py

@@ -6,3 +6,5 @@ from .gender_filter import GenderFilter, Gender
 from .language_filter import LanguageFilter
 from .user_score_filter import UserScoreFilter
 from .custom_filter import CustomFilter
+from .not_filter import NotFilter
+from .or_filter import OrFilter

rapidata/rapidata_client/filter/not_filter.py

@@ -0,0 +1,30 @@
+from typing import Any
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
+from rapidata.api_client.models.not_user_filter_model import NotUserFilterModel
+from rapidata.api_client.models.create_order_model_user_filters_inner import CreateOrderModelUserFiltersInner
+
+
+class NotFilter(RapidataFilter):
+    """A filter that negates another filter's condition.
+    This class implements a logical NOT operation on a given filter, inverting its results.
+
+    Args:
+        filter (RapidataFilter): The filter whose condition should be negated.
+        
+    Example:
+        ```python
+        from rapidata import NotFilter, LanguageFilter
+
+        NotFilter(LanguageFilter(["en"])) 
+        ```
+
+        This will limit the order to be shown to only people who have their phone set to a language other than English.
+    """
+    def __init__(self, filter: RapidataFilter):
+        if not isinstance(filter, RapidataFilter):
+            raise ValueError("Filter must be a RapidataFilter object")
+        
+        self.filter = filter
+
+    def _to_model(self):
+        return NotUserFilterModel(_t="NotFilter", filter=CreateOrderModelUserFiltersInner(self.filter._to_model()))

rapidata/rapidata_client/filter/or_filter.py

@@ -0,0 +1,30 @@
+from typing import Any
+from rapidata.rapidata_client.filter._base_filter import RapidataFilter
+from rapidata.api_client.models.or_user_filter_model import OrUserFilterModel
+from rapidata.api_client.models.create_order_model_user_filters_inner import CreateOrderModelUserFiltersInner
+
+
+class OrFilter(RapidataFilter):
+    """A filter that combines multiple filters with a logical OR operation.
+    This class implements a logical OR operation on a list of filters, where the condition is met if any of the filters' conditions are met.
+
+    Args:
+        filters (list[RapidataFilter]): A list of filters to be combined with OR.
+        
+    Example:
+        ```python
+        from rapidata import OrFilter, LanguageFilter, CountryFilter
+
+        OrFilter([LanguageFilter(["en"]), CountryFilter(["US"])]) 
+        ```
+
+        This will match users who either have their phone set to English OR are located in the United States.
+    """
+    def __init__(self, filters: list[RapidataFilter]):
+        if not all(isinstance(filter, RapidataFilter) for filter in filters):
+            raise ValueError("Filters must be a RapidataFilter object")
+        
+        self.filters = filters
+
+    def _to_model(self):
+        return OrUserFilterModel(_t="OrFilter", filters=[CreateOrderModelUserFiltersInner(filter._to_model()) for filter in self.filters])

rapidata/rapidata_client/filter/rapidata_filters.py

@@ -5,7 +5,8 @@ from rapidata.rapidata_client.filter import (
     GenderFilter, 
     LanguageFilter, 
     UserScoreFilter,
-    CustomFilter)
+    NotFilter,
+    OrFilter)
 
 class RapidataFilters:
     """RapidataFilters Classes
@@ -24,7 +25,8 @@ class RapidataFilters:
         country (CountryFilter): The CountryFilter instance.
         gender (GenderFilter): The GenderFilter instance.
         language (LanguageFilter): The LanguageFilter instance.
-        custom_filter (CustomFilter): The CustomFilter instance.
+        not_filter (NotFilter): The NotFilter instance.
+        or_filter (OrFilter): The OrFilter instance.
 
     Example:
         ```python
@@ -40,4 +42,5 @@ class RapidataFilters:
     country = CountryFilter
     gender = GenderFilter
     language = LanguageFilter
-    custom_filter = CustomFilter
+    not_filter = NotFilter
+    or_filter = OrFilter

rapidata/rapidata_client/order/rapidata_order.py

@@ -51,7 +51,7 @@ class RapidataOrder:
         """Runs the order to start collecting responses."""
         self.__openapi_service.order_api.order_submit_post(self.order_id)
         if print_link:
-            print(f"Order '{self.name}' is now viewable under: https://app.{self.__openapi_service.enviroment}/order/detail/{self.order_id}")
+            print(f"Order '{self.name}' is now viewable under: https://app.{self.__openapi_service.environment}/order/detail/{self.order_id}")
         return self
 
     def pause(self) -> None:
@@ -167,7 +167,7 @@ class RapidataOrder:
             Exception: If the order is not in processing state.
         """        
         campaign_id = self.__get_campaign_id()
-        auth_url = f"https://app.{self.__openapi_service.enviroment}/order/detail/{self.order_id}/preview?campaignId={campaign_id}"
+        auth_url = f"https://app.{self.__openapi_service.environment}/order/detail/{self.order_id}/preview?campaignId={campaign_id}"
         could_open_browser = webbrowser.open(auth_url)
         if not could_open_browser:
             encoded_url = urllib.parse.quote(auth_url, safe="%/:=&?~#+!$,;'@()*[]")

rapidata/rapidata_client/rapidata_client.py

@@ -2,28 +2,37 @@ from rapidata.service.openapi_service import OpenAPIService
 
 from rapidata.rapidata_client.order.rapidata_order_manager import RapidataOrderManager
 
-from rapidata.rapidata_client.validation.validation_set_manager import ValidationSetManager
+from rapidata.rapidata_client.validation.validation_set_manager import (
+    ValidationSetManager,
+)
 
 from rapidata.rapidata_client.demographic.demographic_manager import DemographicManager
 
+
 class RapidataClient:
     """The Rapidata client is the main entry point for interacting with the Rapidata API. It allows you to create orders and validation sets."""
-    
+
     def __init__(
-        self,
-        client_id: str | None = None,
-        client_secret: str | None = None,
-        enviroment: str = "rapidata.ai",
-        oauth_scope: str = "openid",
-        cert_path: str | None = None,
+            self,
+            client_id: str | None = None,
+            client_secret: str | None = None,
+            environment: str = "rapidata.ai",
+            oauth_scope: str = "openid",
+            cert_path: str | None = None,
+            token: dict | None = None,
+            leeway: int = 60
     ):
-        """Initialize the RapidataClient. If both the client_id and client_secret are None, it will try using your credentials under "~/.config/rapidata/credentials.json". 
-        If this is not successful, it will open a browser windown and ask you to log in, then save your new credentials in said json file.
+        """Initialize the RapidataClient. If both the client_id and client_secret are None, it will try using your credentials under "~/.config/rapidata/credentials.json".
+        If this is not successful, it will open a browser window and ask you to log in, then save your new credentials in said json file.
 
         Args:
             client_id (str): The client ID for authentication.
             client_secret (str): The client secret for authentication.
-            enviroment (str, optional): The API endpoint.
+            environment (str, optional): The API endpoint.
+            oauth_scope (str, optional): The scopes to use for authentication. In general this does not need to be changed.
+            cert_path (str, optional): An optional path to a certificate file useful for development.
+            token (dict, optional): If you already have a token that the client should use for authentication. Important, if set, this needs to be the complete token object containing the access token, token type and expiration time.
+            leeway (int, optional): An optional leeway to use to determine if a token is expired. Defaults to 60 seconds.
 
         Attributes:
             order (RapidataOrderManager): The RapidataOrderManager instance.
@@ -32,17 +41,19 @@ class RapidataClient:
         self._openapi_service = OpenAPIService(
             client_id=client_id,
             client_secret=client_secret,
-            enviroment=enviroment,
+            environment=environment,
             oauth_scope=oauth_scope,
-            cert_path=cert_path
+            cert_path=cert_path,
+            token=token,
+            leeway=leeway,
         )
-        
+
         self.order = RapidataOrderManager(openapi_service=self._openapi_service)
-        
+
         self.validation = ValidationSetManager(openapi_service=self._openapi_service)
 
         self._demographic = DemographicManager(openapi_service=self._openapi_service)
 
     def reset_credentials(self):
-        """Reset the credentials saved in the configuration file for the current enviroment."""
+        """Reset the credentials saved in the configuration file for the current environment."""
         self._openapi_service.reset_credentials()

rapidata/rapidata_client/selection/__init__.py

@@ -5,3 +5,5 @@ from .validation_selection import ValidationSelection
 from .conditional_validation_selection import ConditionalValidationSelection
 from .capped_selection import CappedSelection
 from .shuffling_selection import ShufflingSelection
+from .ab_test_selection import AbTestSelection
+from .static_selection import StaticSelection

rapidata/rapidata_client/selection/static_selection.py

@@ -0,0 +1,22 @@
+
+from rapidata.api_client.models.static_selection import StaticSelection as StaticSelectionModel
+from rapidata.rapidata_client.selection._base_selection import RapidataSelection
+
+class StaticSelection(RapidataSelection):
+    """StaticSelection Class
+
+    Given a list of RapidIds, theses specific rapids will be shown in order for every session.
+    
+    Args:
+        selections (list[str]): List of rapid ids to show.
+    """
+
+    def __init__(self, rapid_ids: list[str]):
+        self.rapid_ids = rapid_ids
+
+    def _to_model(self) -> StaticSelectionModel:
+        return StaticSelectionModel(
+            _t="StaticSelection",
+            rapidIds=self.rapid_ids
+        )
+    

rapidata/rapidata_client/validation/validation_set_manager.py

@@ -468,7 +468,7 @@ class ValidationSetManager:
         if print_confirmation:
             print()
             print(f"Validation set '{name}' created with ID {validation_set_id}\n",
-                  f"Now viewable under: https://app.{self.__openapi_service.enviroment}/validation-set/detail/{validation_set_id}",
+                  f"Now viewable under: https://app.{self.__openapi_service.environment}/validation-set/detail/{validation_set_id}",
                   sep="")
         
         if dimensions:

rapidata/service/credential_manager.py

@@ -133,9 +133,9 @@ class CredentialManager:
                 return credential
 
         return self._create_new_credentials()
-    
+
     def reset_credentials(self) -> None:
-        """Reset the stored credentials for current enviroment."""
+        """Reset the stored credentials for current environment."""
         credentials = self._read_credentials()
         if self.endpoint in credentials:
             del credentials[self.endpoint]

rapidata/service/openapi_service.py

@@ -1,3 +1,6 @@
+import subprocess
+from importlib.metadata import version, PackageNotFoundError
+
 from rapidata.api_client.api.campaign_api import CampaignApi
 from rapidata.api_client.api.dataset_api import DatasetApi
 from rapidata.api_client.api.order_api import OrderApi
@@ -7,31 +10,31 @@ from rapidata.api_client.api.validation_api import ValidationApi
 from rapidata.api_client.api.workflow_api import WorkflowApi
 from rapidata.api_client.api_client import ApiClient
 from rapidata.api_client.configuration import Configuration
-from rapidata.service.token_manager import TokenManager, TokenInfo
 from rapidata.service.credential_manager import CredentialManager
 
-from importlib.metadata import version, PackageNotFoundError
-
 
 class OpenAPIService:
     def __init__(
-        self,
-        client_id: str | None,
-        client_secret: str | None,
-        enviroment: str,
-        oauth_scope: str,
-        cert_path: str | None = None,
+            self,
+            client_id: str | None,
+            client_secret: str | None,
+            environment: str,
+            oauth_scope: str,
+            cert_path: str | None = None,
+            token: dict | None = None,
+            leeway: int = 60,
     ):
-        self.enviroment = enviroment
-        endpoint = f"https://api.{enviroment}"
-        self._token_url = f"https://auth.{enviroment}"
-        token_manager = TokenManager(
-            client_id=client_id,
-            client_secret=client_secret,
-            endpoint=self._token_url,
-            oauth_scope=oauth_scope,
-            cert_path=cert_path,
+        self.environment = environment
+        endpoint = f"https://api.{environment}"
+        auth_endpoint = f"https://auth.{environment}"
+
+        if environment == "rapidata.dev" and not cert_path:
+            cert_path = _get_local_certificate()
+
+        self.credential_manager = CredentialManager(
+            endpoint=auth_endpoint, cert_path=cert_path
         )
+
         client_configuration = Configuration(host=endpoint, ssl_ca_cert=cert_path)
         self.api_client = ApiClient(
             configuration=client_configuration,
@@ -39,16 +42,32 @@ class OpenAPIService:
             header_value=f"RapidataPythonSDK/{self._get_rapidata_package_version()}",
         )
 
-        self.api_client.configuration.api_key["bearer"] = (
-            f"Bearer {token_manager.fetch_token().access_token}"
+        if token:
+            self.api_client.rest_client.setup_oauth_with_token(
+                token=token,
+                token_endpoint=f"{auth_endpoint}/connect/token",
+                client_id=client_id,
+                client_secret=client_secret,
+                leeway=leeway,
+            )
+            return
+
+        if not client_id or not client_secret:
+            credentials = self.credential_manager.get_client_credentials()
+            if not credentials:
+                raise ValueError("Failed to fetch client credentials")
+            client_id = credentials.client_id
+            client_secret = credentials.client_secret
+
+        self.api_client.rest_client.setup_oauth_client_credentials(
+            client_id=client_id,
+            client_secret=client_secret,
+            token_endpoint=f"{auth_endpoint}/connect/token",
+            scope=oauth_scope,
         )
 
-        self._cert_path = cert_path
-
-        token_manager.start_token_refresh(token_callback=self._set_token)
-
     def reset_credentials(self):
-        CredentialManager(endpoint=self._token_url, cert_path=self._cert_path).reset_credentials()
+        self.credential_manager.reset_credentials()
 
     @property
     def order_api(self) -> OrderApi:
@@ -78,9 +97,6 @@ class OpenAPIService:
     def workflow_api(self) -> WorkflowApi:
         return WorkflowApi(self.api_client)
 
-    def _set_token(self, token: TokenInfo):
-        self.api_client.configuration.api_key["bearer"] = f"Bearer {token.access_token}"
-
     def _get_rapidata_package_version(self):
         """
         Returns the version of the currently installed rapidata package.
@@ -93,3 +109,15 @@ class OpenAPIService:
             return version("rapidata")
         except PackageNotFoundError:
             return None
+
+
+def _get_local_certificate() -> str | None:
+    result = subprocess.run(["mkcert", "-CAROOT"], capture_output=True)
+    if result.returncode != 0:
+        return None
+
+    output = result.stdout.decode("utf-8").strip()
+    if not output:
+        return None
+
+    return f"{output}/rootCA.pem"

{rapidata-2.17.1.dist-info → rapidata-2.19.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rapidata
-Version: 2.17.1
+Version: 2.19.0
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 Author: Rapidata AG
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: authlib (>=1.5.1,<2.0.0)
 Requires-Dist: colorama (==0.4.6)
 Requires-Dist: deprecated (>=1.2.14,<2.0.0)
 Requires-Dist: pandas (>=2.2.3,<3.0.0)