kodexa 6.0.193__tar.gz → 6.0.195__tar.gz

{kodexa-6.0.193 → kodexa-6.0.195}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kodexa
-Version: 6.0.193
+Version: 6.0.195
 Summary: Python SDK for the Kodexa Platform
 Author: Austin Redenbaugh
 Author-email: austin@kodexa.com

{kodexa-6.0.193 → kodexa-6.0.195}/kodexa/model/objects.py

@@ -1649,6 +1649,38 @@ class FeatureSet(KodexaBaseModel):
     node_features: Optional[List[NodeFeatures]] = Field(None, alias='nodeFeatures')
 
 
+class DocumentViewState(KodexaBaseModel):
+    id: Optional[str] = Field(None, description='The ID of the document view')
+    index: Optional[int] = None
+    document_family_id: Optional[str] = Field(None, alias='documentFamilyId')
+    properties: Optional[Dict[str, Any]] = None
+
+
+class DataFormState(KodexaBaseModel):
+    id: Optional[str] = Field(None, description='The ID of the document view')
+    index: Optional[int] = None
+    properties: Optional[Dict[str, Any]] = None
+
+    data_form_ref: Optional[str] = Field(None, alias='dataFormRef')
+    document_family_ids: Optional[List[str]] = Field(None, alias='documentFamilyIds')
+    data_object_ids: Optional[List[str]] = Field(None, alias='dataObjectIds')
+
+
+class WorkspaceStorage(KodexaBaseModel):
+    document_view_states: Optional[List[DocumentViewState]] = Field(None, alias='documentViewStates')
+    data_form_states: Optional[List[DataFormState]] = Field(None, alias='dataFormStates')
+
+
+class Workspace(KodexaBaseModel):
+    id: Optional[str] = Field(None, description='The ID of the workspace')
+    uuid: Optional[str] = None
+    created_on: Optional[datetime] = Field(None, alias='createdOn')
+    updated_on: Optional[datetime] = Field(None, alias='updatedOn')
+    project: Optional[Project] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+
+
 class DataAttribute(KodexaBaseModel):
     id: Optional[str] = Field(None, description='The ID of the object')
     uuid: Optional[str] = None
@@ -1835,6 +1867,19 @@ class PageProject(KodexaBaseModel):
     empty: Optional[bool] = None
 
 
+class PageWorkspace(KodexaBaseModel):
+    total_pages: Optional[int] = Field(None, alias='totalPages')
+    total_elements: Optional[int] = Field(None, alias='totalElements')
+    size: Optional[int] = None
+    content: Optional[List[Workspace]] = None
+    number: Optional[int] = None
+    pageable: Optional[PageableObject] = None
+    number_of_elements: Optional[int] = Field(None, alias='numberOfElements')
+    first: Optional[bool] = None
+    last: Optional[bool] = None
+    empty: Optional[bool] = None
+
+
 class PageOrganization(KodexaBaseModel):
     total_pages: Optional[int] = Field(None, alias='totalPages')
     total_elements: Optional[int] = Field(None, alias='totalElements')

{kodexa-6.0.193 → kodexa-6.0.195}/kodexa/platform/client.py

@@ -32,7 +32,7 @@ from kodexa.model.objects import PageStore, PageTaxonomy, PageProject, PageOrgan
     PageDataObject, Assistant, ProjectTemplate, PageExtensionPack, DeploymentOptions, PageMembership, Membership, \
     PageDocumentFamily, ProjectResourcesUpdate, DataAttribute, PageNote, PageDataForm, DataForm, Store, PageExecution, \
     Dashboard, PageAction, PagePipeline, DocumentStatus, ModelTraining, PageModelTraining, ContentException, Option, \
-    CustomEvent, ProjectTag, PageDataException, DataException, ReprocessRequest
+    CustomEvent, ProjectTag, PageDataException, DataException, ReprocessRequest, PageWorkspace, Workspace
 
 logger = logging.getLogger()
 
@@ -587,6 +587,14 @@ class PageProjectEndpoint(PageProject, PageEndpoint):
         return "project"
 
 
+class PageWorkspaceEndpoint(PageWorkspace, PageEndpoint):
+    """Represents a page workspace endpoints"""
+
+    def get_type(self) -> Optional[str]:
+        """Get the type of the endpoint"""
+        return "workspace"
+
+
 class PageProjectTemplateEndpoint(PageProjectTemplate, PageEndpoint):
     pass
 
@@ -929,6 +937,30 @@ class ProjectModelStoresEndpoint(ProjectResourceEndpoint):
         return ModelStoreEndpoint
 
 
+class WorkspaceEndpoint(EntityEndpoint, Workspace):
+    """Represents a workspace endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint"""
+        return "workspaces"
+
+    def add_document_family(self, document_family: DocumentFamily):
+        url = f"/api/workspaces/{self.id}/documentFamilies"
+        response = self.client.post(url, body=document_family.to_dict())
+        process_response(response)
+
+    def remove_document_family(self, document_family: DocumentFamily):
+        url = f"/api/workspaces/{self.id}/documentFamilies/{document_family.id}"
+        response = self.client.delete(url)
+        process_response(response)
+
+    def list_document_families(self, page_size=10, page=1) -> PageDocumentFamilyEndpoint:
+        url = f"/api/workspaces/{self.id}/documentFamilies"
+        response = self.client.get(url, {"pageSize": page_size, "page": page})
+        process_response(response)
+        return PageDocumentFamilyEndpoint.parse_obj(response.json()).set_client(self.client)
+
+
 class ProjectEndpoint(EntityEndpoint, Project):
     """Represents a project endpoint"""
 
@@ -990,6 +1022,22 @@ class ProjectEndpoint(EntityEndpoint, Project):
         return [ProjectTag.parse_obj(tag) for tag in response.json()]
 
 
+class WorkspacesEndpoint(EntitiesEndpoint):
+    """Represents a workspaces endpoint"""
+
+    def get_type(self) -> str:
+        """Get the type of the endpoint"""
+        return f"workspaces"
+
+    def get_instance_class(self, object_dict=None) -> Type[BaseModel]:
+        """Get the instance class of the endpoint"""
+        return WorkspaceEndpoint
+
+    def get_page_class(self, object_dict=None) -> Type[BaseModel]:
+        """Get the page class of the endpoint"""
+        return PageWorkspaceEndpoint
+
+
 class ProjectsEndpoint(EntitiesEndpoint):
     """Represents a projects endpoint"""
 
@@ -2418,6 +2466,13 @@ OBJECT_TYPES = {
         "endpoint": ProjectsEndpoint,
         "global": True
     },
+    "workspaces": {
+        "name": "workspace",
+        "plural": "workspaces",
+        "type": WorkspaceEndpoint,
+        "endpoint": WorkspacesEndpoint,
+        "global": True
+    },
     "projectTemplates": {
         "name": "projectTemplate",
         "plural": "projectTemplates",
@@ -2511,6 +2566,7 @@ class KodexaClient:
         self.access_token = access_token if access_token is not None else KodexaPlatform.get_access_token()
         self.organizations = OrganizationsEndpoint(self)
         self.projects = ProjectsEndpoint(self)
+        self.workspaces = WorkspacesEndpoint(self)
         self.users = UsersEndpoint(self)
         self.memberships = MembershipsEndpoint(self)
         self.executions = ExecutionsEndpoint(self)
@@ -2778,7 +2834,8 @@ class KodexaClient:
                 "dashboard": DashboardEndpoint,
                 "execution": ExecutionEndpoint,
                 "assistant": AssistantDefinitionEndpoint,
-                "exception": DataExceptionEndpoint
+                "exception": DataExceptionEndpoint,
+                "workspace": WorkspaceEndpoint,
             }
 
             if component_type in known_components:

{kodexa-6.0.193 → kodexa-6.0.195}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "kodexa"
-version = "6.0.193"
+version = "6.0.195"
 description = "Python SDK for the Kodexa Platform"
 authors = ["Austin Redenbaugh <austin@kodexa.com>", "Philip Dodds <philip@kodexa.com>", "Romar Cablao <rcablao@kodexa.com>", "Amadea Paula Dodds <amadeapaula@kodexa.com>"]
 readme = "README.md"

{kodexa-6.0.193 → kodexa-6.0.195}/setup.py

@@ -37,7 +37,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'kodexa',
-    'version': '6.0.193',
+    'version': '6.0.195',
     'description': 'Python SDK for the Kodexa Platform',
     'long_description': '# Kodexa\n\n[![Build and Package with Poetry](https://github.com/kodexa-ai/kodexa/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/kodexa-ai/kodexa/actions/workflows/main.yml)\n\n![img.png](https://docs.kodexa.com/img.png)\n\nKodexa is a platform for building intelligent document processing pipelines. It is a set of tools and services that\nallow you to build a pipeline that can take a document, extract the content, and then process it to extract the\ninformation you need.\n\nIt is built on a set of core principles:\n\n* **Document Centric** - Kodexa is built around the idea of a document. A document is a collection of content\n  nodes that are connected together. This is a powerful model that allows you to build pipelines that can\n  extract content from a wide range of sources.\n\n* **Pipeline Oriented** - Kodexa is built around the idea of a pipeline. A pipeline is a series of steps that\n  can be executed on a document. This allows you to build a pipeline that can extract content from a wide range\n  of sources.\n\n* **Extensible** - Kodexa is built around the idea of a pipeline. A pipeline is a series of steps that can be executed\n  on a document. This allows you to build a pipeline that can extract content from a wide range of sources.\n\n* **Label Driven** - Kodexa focuses on the idea of labels. Labels are a way to identify content within a document\n  and then use that content to drive the processing of the document.\n\n# Python SDK\n\nThis repository contains the Python SDK for Kodexa. The SDK is the primary way to interact with Kodexa. It allows you to\ndefine actions, models, and pipelines that can be executed on Kodexa. It also includes a complete SDK client for\nworking with a Kodexa platform instance.\n\n## Documentation & Examples\n\nDocumentation is available at the [Kodexa Documentation Portal](https://docs.kodexa.com)\n\n## Current Development\n\nThe main branch is 6.0 which is a production release.\n\n## Set-up\n\nWe use poetry to manage our dependencies, so you can install them with:\n\n    poetry install\n\nYou can then run the tests with:\n\n    poetry run pytest\n\n# Contributing\n\nWe welcome contributions to the Kodexa platform. Please see our [contributing guide](CONTRIBUTING.md) for more details.\n\n# License\n\nApache 2.0\n',
     'author': 'Austin Redenbaugh',