arthur-client 1.3.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

arthur/client/rest/query/models.py

@@ -1,133 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  query.yaml
-#   timestamp: 2024-01-24T16:44:21+00:00
-
-from __future__ import annotations
-
-from enum import Enum
-from typing import List, Optional
-
-from arthur.client.rest.common.models import (
-    DataDriftRequestBase,
-    QueryFilters,
-    QueryGroupBy,
-    ResultRow,
-)
-from pydantic import BaseModel
-
-
-class QueryResult(BaseModel):
-    query_result: List[ResultRow]
-    sampling_threshold: Optional[float] = None
-
-
-class DistributionsAttribute(BaseModel):
-    property: str
-    """
-    The name of the property to select. This can be the name of any attribute associated with the model.
-    """
-    alias: Optional[str] = None
-    """
-    If an alias is provided, this will be returned as the name for the associated result.
-    """
-    num_bins: Optional[float] = None
-    """
-    The number of "buckets" to distribute the attribute into. Value must be at least 2 and no greater than 200. If not specified, we will default to 20.
-    """
-
-
-class DistributionValue(BaseModel):
-    function: Optional[str] = None
-    """
-    optional, an aggregation function like count, sum, abs, max, min, avg
-    """
-    property: str
-    """
-    The name of the property to select. This can be the name of any attribute associated with the model.
-    """
-    alias: Optional[str] = None
-    """
-    If an alias is provided, this will be returned as the name for the associated result.
-    """
-
-
-class Rollup(str, Enum):
-    """
-    An optional parameter that will aggregate the calculated PSI value by the supported dimension.
-    """
-
-    minute = 'minute'
-    hour = 'hour'
-    day = 'day'
-    month = 'month'
-    year = 'year'
-    batch_id = 'batch_id'
-
-
-class DataDriftTableRequest(BaseModel):
-    property: str
-    """
-    This will be the name of one of the model's attributes or an enriched attribute. Required if alias is not provided.
-    """
-    num_bins: Optional[int] = None
-    """
-    Continuous attributes only - Sets the number of bins in which to perform the (PSI)[https://scholarworks.wmich.edu/cgi/viewcontent.cgi?article=4249&context=dissertations] calculation.  Bin boundaries are created by assigning each data point of the continuous property to 1 of [numBins] quantiles. For example: If you have an attribute of 100 values from 1 to 100, and passed numBins = 10, then 10 bins would be created with boundaries at 10, 20, 30, ..., 100
-    """
-    base: DataDriftRequestBase
-    target: DataDriftRequestBase
-    group_by: Optional[QueryGroupBy] = None
-    rollup: Optional[Rollup] = None
-    """
-    An optional parameter that will aggregate the calculated PSI value by the supported dimension.
-    """
-
-
-class DistributionsRequest(BaseModel):
-    x: DistributionsAttribute
-    y: DistributionsAttribute
-    values: Optional[List[DistributionValue]] = None
-    filter: Optional[QueryFilters] = None
-
-
-class Rollup1(str, Enum):
-    minute = 'minute'
-    hour = 'hour'
-    day = 'day'
-    month = 'month'
-    year = 'year'
-    batch_id = 'batch_id'
-
-
-class PSIBucketValue(BaseModel):
-    bucket: Optional[str] = None
-    rollup: Optional[Rollup1] = None
-    group_by_property: Optional[str] = None
-    base_bucket_max: Optional[float] = None
-    base_bucket_min: Optional[float] = None
-    base_count_per_bucket: Optional[float] = None
-    base_ln_probability_per_bucket: Optional[float] = None
-    base_probability_per_bucket: Optional[float] = None
-    base_total: Optional[float] = None
-    target_bucket_max: Optional[float] = None
-    target_bucket_min: Optional[float] = None
-    target_count_per_bucket: Optional[float] = None
-    target_ln_probability_per_bucket: Optional[float] = None
-    target_probability_per_bucket: Optional[float] = None
-    target_total: Optional[float] = None
-    probability_difference: Optional[float] = None
-    ln_probability_difference: Optional[float] = None
-    psi: Optional[float] = None
-
-
-class PsiValue(BaseModel):
-    rollup: Optional[Rollup1] = None
-    group_by_property: Optional[str] = None
-    psi_value: Optional[float] = None
-
-
-class DataDriftResponse(BaseModel):
-    query_result: Optional[List[PsiValue]] = None
-
-
-class DataDriftTableResponse(BaseModel):
-    query_result: Optional[List[PSIBucketValue]] = None

arthur/client/rest/users/__init__.py

@@ -1,2 +0,0 @@
-from . import models
-from . import client

arthur/client/rest/users/client.py

@@ -1,171 +0,0 @@
-from typing import Optional, Any, Union, Dict, List, Tuple
-from http import HTTPStatus
-from requests.cookies import RequestsCookieJar
-from requests import Response
-
-# import http client
-from arthur.client.http.requests import HTTPClient
-
-from arthur.client.rest.users.models import (
-    AuthenticationInfo,
-    InviteRequest,
-    InviteResponse,
-    NewUserRequest,
-    PaginatedUsers,
-    UpdateCurrentUserRequest,
-    UpdateUserRequest,
-    User,
-    UserResponse,
-)
-
-
-PATH_PREFIX = "/api"
-
-
-class ArthurUsersClient:
-    """
-    A Python client to interact with the Arthur Users API
-    """
-
-    def __init__(self, http_client: HTTPClient):
-        """
-        Create a new ArthurUsersClient from an HTTPClient
-
-        :param http_client: the :class:`~arthurai.client.http.requests.HTTPClient` to use for underlying requests
-        """
-        self.http_client = http_client
-        self.http_client.set_path_prefix(PATH_PREFIX)
-
-    def authenticate(self) -> AuthenticationInfo:
-        """
-        Returns authentication info for the calling, token-bearing user
-
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/users/me/auth_info", validation_response_code=200
-        )
-        return AuthenticationInfo(**parsed_resp)
-
-    def get_paginated_users(
-        self,
-        page: Optional[int] = None,
-        page_size: Optional[int] = None,
-        sort: Optional[str] = None,
-    ) -> PaginatedUsers:
-        """
-        Returns a paginated list of users
-
-        :param page:
-        :param page_size:
-        :param sort: Must be supplied in the format [column_name] to denote asc sort by this column OR -[column_name] to denote desc sort by this column
-        """
-
-        params: Dict[str, Any] = {}
-        if page is not None:
-            params["page"] = page
-        if page_size is not None:
-            params["page_size"] = page_size
-        if sort is not None:
-            params["sort"] = sort
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/users", params=params, validation_response_code=200
-        )
-        return PaginatedUsers(**parsed_resp)
-
-    def create_user(self, json_body: NewUserRequest) -> User:
-        """
-        Creates a new user
-
-        :param json_body:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.post(  # type: ignore
-            f"/v3/users",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=201,
-        )
-        return User(**parsed_resp)
-
-    def get_current_user(self) -> UserResponse:
-        """
-        Returns the currently authenticated user
-
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/users/me", validation_response_code=200
-        )
-        return UserResponse(**parsed_resp)
-
-    def update_current_user(self, json_body: UpdateCurrentUserRequest) -> UserResponse:
-        """
-        Updates the currently authenticated user
-
-        :param json_body:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.patch(  # type: ignore
-            f"/v3/users/me",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=200,
-        )
-        return UserResponse(**parsed_resp)
-
-    def get_user_by_id(self, user_id: str) -> User:
-        """
-        Returns a single user
-
-        :param user_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/users/{user_id}", validation_response_code=200
-        )
-        return User(**parsed_resp)
-
-    def delete_user(self, user_id: str) -> Response:
-        """
-        Deletes a user (by marking them as inactive) and invalidates any existing api keys
-
-        :param user_id:
-        """
-
-        raw_resp: Response = self.http_client.delete(  # type: ignore
-            f"/v3/users/{user_id}",
-            validation_response_code=204,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def update_user(self, user_id: str, json_body: UpdateUserRequest) -> User:
-        """
-        Updates a user
-
-        Request to update the password must include the old password unless a super admin is making the request.
-
-        :param user_id:
-        :param json_body:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.patch(  # type: ignore
-            f"/v3/users/{user_id}",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=200,
-        )
-        return User(**parsed_resp)
-
-    def send_user_invites(self, json_body: InviteRequest) -> InviteResponse:
-        """
-        Send email invitations to have users join the requesters organization
-
-        :param json_body:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.post(  # type: ignore
-            f"/v3/users/invite_users",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=200,
-        )
-        return InviteResponse(**parsed_resp)

arthur/client/rest/users/models.py

@@ -1,317 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  users.yaml
-#   timestamp: 2024-01-24T16:44:21+00:00
-
-from __future__ import annotations
-
-from datetime import datetime
-from typing import Any, Dict, List, Optional
-from uuid import UUID
-
-from arthur.client.rest.common.models import Page, PageSize, TotalCount, TotalPages
-from pydantic import BaseModel, Field
-
-
-class UpdateCurrentUserRequest(BaseModel):
-    old_password: Optional[str] = None
-    """
-    The user's old password.
-    """
-    new_password: Optional[str] = None
-    """
-    The user's new password
-    """
-    first_name: Optional[str] = None
-    """
-    The user's first name
-    """
-    last_name: Optional[str] = None
-    """
-    The user's last name
-    """
-    email: Optional[str] = None
-    """
-    The user's email
-    """
-    username: Optional[str] = None
-    """
-    The username the user will use to login
-    """
-    show_intro_sequence: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether the user should be shown the intro sequence upon login
-    """
-    help_mode_enabled: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether or not to show dashboard tooltips
-    """
-
-
-class UpdateUserRequest(BaseModel):
-    old_password: Optional[str] = None
-    """
-    The user's old password. Not required to update the password if the caller is a super admin.
-    """
-    new_password: Optional[str] = None
-    """
-    The user's new password
-    """
-    first_name: Optional[str] = None
-    """
-    The user's first name
-    """
-    last_name: Optional[str] = None
-    """
-    The user's last name
-    """
-    email: Optional[str] = None
-    """
-    The user's email
-    """
-    username: Optional[str] = None
-    """
-    The username the user will use to login
-    """
-    roles: Optional[List[str]] = None
-    show_intro_sequence: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether the user should be shown the intro sequence upon login
-    """
-    help_mode_enabled: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether or not to show dashboard tooltips
-    """
-
-
-class UserContext(BaseModel):
-    name: Optional[str] = None
-    """
-    Name of the context.
-    """
-    id: Optional[str] = None
-    """
-    UUID of the context.
-    """
-
-
-class User(BaseModel):
-    id: str
-    """
-    the unique id of the user
-    """
-    first_name: Optional[str] = None
-    """
-    The user's first name
-    """
-    last_name: Optional[str] = None
-    """
-    The user's last name
-    """
-    email: str
-    """
-    The user's email
-    """
-    username: Optional[str] = None
-    """
-    The username the user can use to login
-    """
-    roles: Optional[List[str]] = None
-    """
-    The user's roles in the current organization.
-    """
-    alert_notifications_enabled: Optional[bool] = None
-    """
-    Whether or not the user will receive email notifications when alerts are triggered, defaults to 'false'
-    """
-    show_intro_sequence: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether or not to show the user an intro sequence upon login
-    """
-    help_mode_enabled: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether or not to show dashboard tooltips
-    """
-    created_at: Optional[datetime] = None
-    """
-    UTC timestamp of when the user was created
-    """
-
-
-class InviteResponse(BaseModel):
-    """
-    returned if and only if return_direct_links is set to true; returns a map of emails to invite links
-    """
-
-    user_invite_links: Optional[Dict[str, Any]] = None
-    """
-    a mapping where each email signup is a key and its corresponding signup invite link is the value
-    """
-
-
-class AuthenticationInfo(BaseModel):
-    organization_ids: List[str]
-    """
-    A list of organization IDs.
-    """
-    issuer: str
-    """
-    The identifier of the IDP managing this user.
-    """
-    external_user_id: Optional[str] = None
-    """
-    An identifier for an external-IdP token bearer. Populated if this user's token came from an IDP and the IDP configuration specified an oidc.CustomClaimNames that mapped UserID to a claim.
-    """
-    internal_user_id: Optional[str] = None
-    """
-    An identifier for an Arthur-internal user. Populated for Arthur-authenticated users with user tokens.
-    """
-    service_account_id: Optional[str] = None
-    """
-    An identifier for an Arthur service account. Populated for Arthur-authenticated service account tokens.
-    """
-    username: str
-    """
-    Either the Arthur username or the username specified by an external IDP. This will be set to arthur.ServiceAccountName for service account tokens.
-    """
-    first_name: str
-    """
-    The first name of the Arthur authenticated user, or the first name claim if the external IDP is configured with one.
-    """
-    last_name: str
-    """
-    The last name of the Arthur authenticated user, or the last name claim if the external IDP is configured with one.
-    """
-    email: str
-    """
-    The email of the Arthur authenticated user or the email of the external IDP user if the IDP is configured with that claim. For Arthur service accounts, this will be empty.
-    """
-    roles: List[str]
-    """
-    The list of roles that this user has. For Arthur tokens, there will always be one role in this array; however, there can be more than one for external providers.
-    """
-
-
-class NewUserRequest(BaseModel):
-    first_name: Optional[str] = None
-    """
-    The user's first name
-    """
-    last_name: Optional[str] = None
-    """
-    The user's last name
-    """
-    email: str
-    """
-    The user's email
-    """
-    username: str
-    """
-    The username the user will use to login
-    """
-    password: str
-    """
-    The user's password
-    """
-    roles: List[str]
-    """
-    Available Standard Roles are [Administrator, Model Owner, User].
-    """
-    alert_notifications_enabled: Optional[bool] = None
-    """
-    Whether or not the user will receive email notifications when alerts are triggered, defaults to 'false'
-    """
-
-
-class UserResponse(BaseModel):
-    """
-    Represents an application user, if the client is using a service token then only organization_id and roles will be populated in the object
-    """
-
-    id: Optional[str] = None
-    """
-    the unique id of the user
-    """
-    organization_id: str
-    """
-    The ID of the users current context
-    """
-    organization_name: Optional[str] = None
-    """
-    The name of the users current context
-    """
-    first_name: Optional[str] = None
-    """
-    The user's first name
-    """
-    last_name: Optional[str] = None
-    """
-    The user's last name
-    """
-    email: Optional[str] = None
-    """
-    The user's email
-    """
-    username: Optional[str] = None
-    """
-    The username the user can use to login
-    """
-    roles: List[str]
-    """
-    The user's roles
-    """
-    alert_notifications_enabled: Optional[bool] = None
-    """
-    Whether or not the user will receive email notifications when alerts are triggered, defaults to 'false'
-    """
-    show_intro_sequence: Optional[bool] = None
-    """
-    used by the Arthur dashboard to determine whether the user should be shown the intro sequence upon login
-    """
-    help_mode_enabled: Optional[bool] = None
-    """
-    Used by the Arthur dashboard to determine whether or not to show dashboard tooltips
-    """
-    plan: Optional[str] = None
-    """
-    string representation of what plan the org of the returned user is associated with (ie. self-service or paidSaas)
-    """
-    created_at: Optional[datetime] = None
-    """
-    UTC timestamp of when the user was created
-    """
-    contexts: Optional[List[UserContext]] = None
-    """
-    Contexts that the user has permissions in.
-    """
-
-
-class PaginatedUsers(BaseModel):
-    data: List[User]
-    """
-    List of users.
-    """
-    page: Page
-    page_size: PageSize
-    total_pages: Optional[TotalPages] = None
-    total_count: Optional[TotalCount] = None
-
-
-class InviteRequest(BaseModel):
-    invite_emails: List[str]
-    """
-    A list of emails to invite to the organization of the inviting user
-    """
-    return_direct_links: Optional[bool] = Field(False, example=True)
-    """
-    If set to true, invite emails will not be sent; instead, the signup links will be returned directly in the api response. If set to false email invites will be sent and the response body will be null.
-    """
-    custom_dashboard_url: Optional[str] = Field(None, example='beta.kots.dev.arthur.ai')
-    """
-    Set this if you want the invite links to be prefixed with a URL different from the default
-    """
-    organization_id: Optional[UUID] = Field(
-        None, example='b4e2c14d-85f6-405a-b184-ca9fbca2604f'
-    )
-    """
-    Set this if and only if calling as superadmin, otherwise it will return an error; this specifies the org to invite the users to
-    """

arthur/client/types.py

@@ -1,9 +0,0 @@
-from io import IOBase
-from typing import Union, Tuple
-
-
-# multipart file types
-NamedFile = Union[
-    Tuple[str, IOBase], Tuple[str, IOBase, str]
-]  # tuple like ("fname", data, [encoding])
-ByteField = Union[bytes, IOBase, NamedFile]

arthur/client/version.py

@@ -1,2 +0,0 @@
-__version__ = "1.3.0"
-api_spec_version = "3.0.0"

arthur/common/__init__.py

@@ -1,3 +0,0 @@
-"""
-Constants, exceptions, and logging for use in other packages
-"""

arthur/common/constants.py

@@ -1,5 +0,0 @@
-"""
-Constants from our models that are often used by other libraries
-"""
-
-from arthur.client.rest.models.models import InputType, OutputType, ValueType, Stage