diff --git a/deepsearch/__init__.py b/deepsearch/__init__.py index 8ef5a951..3aab3a07 100644 --- a/deepsearch/__init__.py +++ b/deepsearch/__init__.py @@ -1,6 +1,7 @@ """ DeepSearch Toolkit """ + from .core import DeepSearchBearerTokenAuth, DeepSearchConfig, DeepSearchKeyAuth from .core.util._version import version from .cps import CpsApi, CpsApiClient diff --git a/deepsearch/cps/client/components/data_indices.py b/deepsearch/cps/client/components/data_indices.py index a8357c3e..2a3635b0 100644 --- a/deepsearch/cps/client/components/data_indices.py +++ b/deepsearch/cps/client/components/data_indices.py @@ -34,9 +34,9 @@ def __init__(self, api: CpsApi) -> None: self.sw_api = sw_client.DataIndicesApi(self.api.client.swagger_client) def list(self, proj_key: str) -> List[DataIndex]: - response: list[ - sw_client.ProjectDataIndexWithStatus - ] = self.sw_api.get_project_data_indices(proj_key=proj_key) + response: list[sw_client.ProjectDataIndexWithStatus] = ( + self.sw_api.get_project_data_indices(proj_key=proj_key) + ) # filter out saved searchs index return [ diff --git a/deepsearch/cps/client/components/elastic.py b/deepsearch/cps/client/components/elastic.py index 0995d816..964ffccf 100644 --- a/deepsearch/cps/client/components/elastic.py +++ b/deepsearch/cps/client/components/elastic.py @@ -25,10 +25,10 @@ def __init__(self, api: CpsApi) -> None: self.sw_api = sw_client.ElasticApi(self.api.client.swagger_client) def list(self, domain: str = "all") -> List[ElasticDataCollection]: - response: list[ - sw_client.DataCollection - ] = self.sw_api.list_indices_from_elastic_instance( - index_type="all", index_domain=domain + response: list[sw_client.DataCollection] = ( + self.sw_api.list_indices_from_elastic_instance( + index_type="all", index_domain=domain + ) ) return [ diff --git a/deepsearch/cps/client/components/knowledge_graphs.py b/deepsearch/cps/client/components/knowledge_graphs.py index 7774b6fa..2fbf3636 100644 --- a/deepsearch/cps/client/components/knowledge_graphs.py +++ b/deepsearch/cps/client/components/knowledge_graphs.py @@ -129,10 +129,12 @@ def save_snapshot_of_data_flow( if name is not None: body["snapshot"]["name"] = name - task: ProjectTask = self.api.knowledge_graphs.sw_api.backend_create_project_kg_snapshot_from_data_flow_assembly( - proj_key=self.project, - bag_key=self.key, - body=body, + task: ProjectTask = ( + self.api.knowledge_graphs.sw_api.backend_create_project_kg_snapshot_from_data_flow_assembly( + proj_key=self.project, + bag_key=self.key, + body=body, + ) ) return task diff --git a/deepsearch/cps/client/queries/query.py b/deepsearch/cps/client/queries/query.py index c7b15682..79999368 100644 --- a/deepsearch/cps/client/queries/query.py +++ b/deepsearch/cps/client/queries/query.py @@ -12,8 +12,7 @@ def __init__(self) -> None: self.paginated_task: Optional[Task] = None @overload - def add(self, kind_or_task: TTask) -> TTask: - ... + def add(self, kind_or_task: TTask) -> TTask: ... @overload def add( @@ -24,8 +23,7 @@ def add( parameters: Optional[Dict[str, Any]] = None, inputs: Optional[TaskInputs] = None, coordinates: Optional[TaskCoordinates] = None, - ) -> Task: - ... + ) -> Task: ... def add( self, diff --git a/deepsearch/cps/client/queries/task.py b/deepsearch/cps/client/queries/task.py index 0448c5f0..3d096a18 100644 --- a/deepsearch/cps/client/queries/task.py +++ b/deepsearch/cps/client/queries/task.py @@ -15,8 +15,7 @@ class Resource(Protocol): """Models which implement this Protocol can be passed as coordinates to tasks""" - def to_resource(self) -> Dict[str, Any]: - ... + def to_resource(self) -> Dict[str, Any]: ... class Output: @@ -49,8 +48,7 @@ def __init__(self, value: Any) -> None: class TaskWithWellKnownOutputs(Protocol[TOutputs]): @property - def outputs(self) -> TOutputs: - ... + def outputs(self) -> TOutputs: ... class Task: @@ -111,12 +109,10 @@ def _build_inputs(self) -> Dict[str, Any]: def _build_coordinates(self) -> Dict[str, Any]: @overload - def _build(value: Dict[str, Any]) -> Dict[str, Any]: - ... + def _build(value: Dict[str, Any]) -> Dict[str, Any]: ... @overload - def _build(value: TaskCoordinates) -> Dict[str, Any]: - ... + def _build(value: TaskCoordinates) -> Dict[str, Any]: ... def _build(value: Any) -> Any: if isinstance(value, tuple): diff --git a/deepsearch/documents/core/create_report.py b/deepsearch/documents/core/create_report.py index 976c13c2..12c74843 100644 --- a/deepsearch/documents/core/create_report.py +++ b/deepsearch/documents/core/create_report.py @@ -60,7 +60,11 @@ def get_multiple_reports( Generates reports for multiple tasks_ids and associated documents. """ reports = [] - count, count_doc, count_failed_doc, = ( + ( + count, + count_doc, + count_failed_doc, + ) = ( 0, 0, 0, diff --git a/deepsearch/documents/core/export.py b/deepsearch/documents/core/export.py index 245908ab..b6a73a91 100644 --- a/deepsearch/documents/core/export.py +++ b/deepsearch/documents/core/export.py @@ -734,9 +734,11 @@ def write_table(self, item): table_min_bbox_str = " ".join( [ - 'data-min-{}="{}"'.format(k, v) - if k != "page" - else 'data-{}="{}"'.format(k, v) + ( + 'data-min-{}="{}"'.format(k, v) + if k != "page" + else 'data-{}="{}"'.format(k, v) + ) for k, v in table_bbox.items() ] ) diff --git a/deepsearch/documents/core/lookup.py b/deepsearch/documents/core/lookup.py index 5ea9a74d..3d71f7d3 100644 --- a/deepsearch/documents/core/lookup.py +++ b/deepsearch/documents/core/lookup.py @@ -35,9 +35,9 @@ class _MatchedEntry(BaseModel): def __init__(self, document: Dict[str, Any]): self.document = document - self._lookup: Dict[ - str, Dict[str, List[EntitiesLookup._MatchedEntry]] - ] = {} # {entity_type: {entity_instance: [reference, ...]}} + self._lookup: Dict[str, Dict[str, List[EntitiesLookup._MatchedEntry]]] = ( + {} + ) # {entity_type: {entity_instance: [reference, ...]}} self._build() def _build(self): diff --git a/deepsearch/model/server/model_app.py b/deepsearch/model/server/model_app.py index 3f8a69f9..054626de 100644 --- a/deepsearch/model/server/model_app.py +++ b/deepsearch/model/server/model_app.py @@ -100,12 +100,12 @@ async def predict( "MY_POD_NAME", "local" ) result.headers["X-Request-Arrival-Time"] = str(request_arrival_time) - result.headers[ - "X-Request-Attempt-Number" - ] = request.metadata.annotations.deepsearch_res_ibm_com_x_attempt_number - result.headers[ - "X-Request-Transaction-Id" - ] = request.metadata.annotations.deepsearch_res_ibm_com_x_transaction_id + result.headers["X-Request-Attempt-Number"] = ( + request.metadata.annotations.deepsearch_res_ibm_com_x_attempt_number + ) + result.headers["X-Request-Transaction-Id"] = ( + request.metadata.annotations.deepsearch_res_ibm_com_x_transaction_id + ) return result except (asyncio.TimeoutError, HTTPException) as e: diff --git a/docs/apis/public_v2/README.md b/docs/apis/public_v2/README.md new file mode 100644 index 00000000..09f733ac --- /dev/null +++ b/docs/apis/public_v2/README.md @@ -0,0 +1,302 @@ +# ds-public +API for Deep Search. + +**WARNING**: This API is subject to change without warning! + +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 3.0.0 +- Package version: 2.0.0 +- Generator version: 7.4.0 +- Build package: org.openapitools.codegen.languages.PythonClientCodegen + +## Requirements. + +Python 3.7+ + +## Installation & Usage +### pip install + +If the python package is hosted on a repository, you can install directly using: + +```sh +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git +``` +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) + +Then import the package: +```python +import deepsearch.cps.apis.public_v2 +``` + +### Setuptools + +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import deepsearch.cps.apis.public_v2 +``` + +### Tests + +Execute `pytest` to run the tests. + +## Getting Started + +Please follow the [installation procedure](#installation--usage) and then run the following: + +```python + +import deepsearch.cps.apis.public_v2 +from deepsearch.cps.apis.public_v2.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/cps/public/v2 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public_v2.Configuration( + host = "/api/cps/public/v2" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration.api_key['Bearer'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Bearer'] = 'Bearer' + + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public_v2.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public_v2.ContentManagerApi(api_client) + index_key = 'index_key_example' # str | + proj_key = 'proj_key_example' # str | + page = 1 # int | (optional) (default to 1) + page_size = 25 # int | (optional) (default to 25) + + try: + # Get All Project Data Index Documents + api_response = api_instance.get_all_project_data_index_documents(index_key, proj_key, page=page, page_size=page_size) + print("The response of ContentManagerApi->get_all_project_data_index_documents:\n") + pprint(api_response) + except ApiException as e: + print("Exception when calling ContentManagerApi->get_all_project_data_index_documents: %s\n" % e) + +``` + +## Documentation for API Endpoints + +All URIs are relative to */api/cps/public/v2* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*ContentManagerApi* | [**get_all_project_data_index_documents**](docs/ContentManagerApi.md#get_all_project_data_index_documents) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/ | Get All Project Data Index Documents +*ContentManagerApi* | [**get_project_agents**](docs/ContentManagerApi.md#get_project_agents) | **GET** /project/{proj_key}/data_indices/documents/agents | Get Project Agents +*ContentManagerApi* | [**get_project_conversion_statistics**](docs/ContentManagerApi.md#get_project_conversion_statistics) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/statistics | Get Project Conversion Statistics +*ContentManagerApi* | [**get_project_data_index_document_artifacts**](docs/ContentManagerApi.md#get_project_data_index_document_artifacts) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/artifacts | Get Project Data Index Document Artifacts +*ContentManagerApi* | [**get_project_data_index_document_events**](docs/ContentManagerApi.md#get_project_data_index_document_events) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/doc_events | Get Project Data Index Document Events +*ContentManagerApi* | [**get_project_data_index_document_markdown**](docs/ContentManagerApi.md#get_project_data_index_document_markdown) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/Markdown | Get Project Data Index Document Markdown +*ContentManagerApi* | [**get_project_data_index_document_metadata**](docs/ContentManagerApi.md#get_project_data_index_document_metadata) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/metadata | Get Project Data Index Document Metadata +*ContentManagerApi* | [**get_project_data_index_documents**](docs/ContentManagerApi.md#get_project_data_index_documents) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name} | Get Project Data Index Documents +*ContentManagerApi* | [**get_project_data_index_grouped_documents**](docs/ContentManagerApi.md#get_project_data_index_grouped_documents) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}/grouped | Get Project Data Index Grouped Documents +*ContentManagerApi* | [**get_project_data_index_json_document**](docs/ContentManagerApi.md#get_project_data_index_json_document) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/JSON | Get Project Data Index Json Document +*ContentManagerApi* | [**get_project_data_index_pdf_document**](docs/ContentManagerApi.md#get_project_data_index_pdf_document) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/PDF | Get Project Data Index Pdf Document +*ContentManagerApi* | [**get_project_documents_by_transaction**](docs/ContentManagerApi.md#get_project_documents_by_transaction) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/transactions/{transaction_id} | Get Project Documents By Transaction +*ContentManagerApi* | [**get_project_index_upload_jobs**](docs/ContentManagerApi.md#get_project_index_upload_jobs) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/upload_jobs | Get Project Index Upload Jobs +*DataIndicesApi* | [**create_project_data_index**](docs/DataIndicesApi.md#create_project_data_index) | **POST** /project/{proj_key}/data_indices | Create Project Data Index +*DataIndicesApi* | [**create_project_data_index_delete_token**](docs/DataIndicesApi.md#create_project_data_index_delete_token) | **POST** /project/{proj_key}/data_indices/{index_key}/delete_token | Create Project Data Index Delete Token +*DataIndicesApi* | [**delete_project_data_index**](docs/DataIndicesApi.md#delete_project_data_index) | **DELETE** /project/{proj_key}/data_indices/{index_key} | Delete Project Data Index +*DataIndicesApi* | [**get_project_data_index**](docs/DataIndicesApi.md#get_project_data_index) | **GET** /project/{proj_key}/data_indices/{index_key} | Get Project Data Index +*DataIndicesApi* | [**get_project_data_indices**](docs/DataIndicesApi.md#get_project_data_indices) | **GET** /project/{proj_key}/data_indices | Get Project Data Indices +*DataIndicesApi* | [**update_project_data_index**](docs/DataIndicesApi.md#update_project_data_index) | **PATCH** /project/{proj_key}/data_indices/{index_key} | Update Project Data Index +*DataIndicesUploadApi* | [**ccs_convert_file_project_data_index**](docs/DataIndicesUploadApi.md#ccs_convert_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert | Ccs Convert File Project Data Index +*DataIndicesUploadApi* | [**ccs_convert_upload_file_project_data_index**](docs/DataIndicesUploadApi.md#ccs_convert_upload_file_project_data_index) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload | Ccs Convert Upload File Project Data Index +*DataIndicesUploadApi* | [**get_attachment_upload_data**](docs/DataIndicesUploadApi.md#get_attachment_upload_data) | **GET** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename} | Get Attachment Upload Data +*DataIndicesUploadApi* | [**html_print_convert_upload**](docs/DataIndicesUploadApi.md#html_print_convert_upload) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload | Html Print Convert Upload +*DataIndicesUploadApi* | [**load_project_data_index_files_elastic**](docs/DataIndicesUploadApi.md#load_project_data_index_files_elastic) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/load_elastic | Load Project Data Index Files Elastic +*DataIndicesUploadApi* | [**register_attachment**](docs/DataIndicesUploadApi.md#register_attachment) | **POST** /project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment | Register Attachment +*DataIndicesUploadApi* | [**upload_project_data_index_file**](docs/DataIndicesUploadApi.md#upload_project_data_index_file) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload | Upload Project Data Index File +*DataIndicesUploadApi* | [**upload_register_project_documents**](docs/DataIndicesUploadApi.md#upload_register_project_documents) | **POST** /project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents | Upload Register Project Documents +*KnowledgeGraphsApi* | [**backend_list_project_kgs**](docs/KnowledgeGraphsApi.md#backend_list_project_kgs) | **GET** /backend/project/{proj_key}/bags | Backend List Project Kgs +*KnowledgeGraphsApi* | [**create_project_knowledge_graph**](docs/KnowledgeGraphsApi.md#create_project_knowledge_graph) | **POST** /backend/project/{proj_key}/bags | Create Project Knowledge Graph +*KnowledgeGraphsApi* | [**list_public_knowledge_graphs**](docs/KnowledgeGraphsApi.md#list_public_knowledge_graphs) | **GET** /project/public/bags | List Public Knowledge Graphs +*KnowledgeGraphsApi* | [**update_project_knowledge_graph_metadata**](docs/KnowledgeGraphsApi.md#update_project_knowledge_graph_metadata) | **PATCH** /backend/project/{proj_key}/bags/{bag_key} | Update Project Knowledge Graph Metadata +*ProjectApi* | [**check_wait_ccs_task_task**](docs/ProjectApi.md#check_wait_ccs_task_task) | **GET** /project/{proj_key}/convert_tasks/{task_id} | Check Wait Ccs Task Task +*ProjectApi* | [**convert_pdf_document**](docs/ProjectApi.md#convert_pdf_document) | **POST** /project/{proj_key}/convert | Convert Pdf Document +*ProjectApi* | [**delete_project_integration_config_genai**](docs/ProjectApi.md#delete_project_integration_config_genai) | **DELETE** /project/{proj_key}/integrations/genai | Delete Project Integration Config Genai +*ProjectApi* | [**get_project_default_values**](docs/ProjectApi.md#get_project_default_values) | **GET** /project/{proj_key}/default_values | Get Project Default Values +*ProjectApi* | [**get_project_integration_config_genai**](docs/ProjectApi.md#get_project_integration_config_genai) | **GET** /project/{proj_key}/integrations/genai | Get Project Integration Config Genai +*ProjectApi* | [**provision_project_packages**](docs/ProjectApi.md#provision_project_packages) | **POST** /project/{proj_key}/packages | Provision Project Packages +*ProjectApi* | [**update_project_default_values**](docs/ProjectApi.md#update_project_default_values) | **POST** /project/{proj_key}/default_values | Update Project Default Values +*ProjectApi* | [**update_project_integration_config_genai**](docs/ProjectApi.md#update_project_integration_config_genai) | **POST** /project/{proj_key}/integrations/genai | Update Project Integration Config Genai +*SemanticApi* | [**ingest**](docs/SemanticApi.md#ingest) | **POST** /project/{proj_key}/semantic/ingest | Ingest +*SystemApi* | [**get_system_information**](docs/SystemApi.md#get_system_information) | **GET** /system/info | Get System Information +*SystemApi* | [**get_system_modules_configuration**](docs/SystemApi.md#get_system_modules_configuration) | **GET** /system/modules/configuration | Get System Modules Configuration +*SystemApi* | [**get_system_modules_tasks**](docs/SystemApi.md#get_system_modules_tasks) | **GET** /system/modules/tasks | Get System Modules Tasks +*SystemApi* | [**list_packages**](docs/SystemApi.md#list_packages) | **GET** /system/packages | List Packages +*SystemApi* | [**list_system_knowledge_graphs**](docs/SystemApi.md#list_system_knowledge_graphs) | **GET** /system/kgs | List System Knowledge Graphs +*SystemApi* | [**system_get_all_dcs_admin**](docs/SystemApi.md#system_get_all_dcs_admin) | **GET** /system/admin/get_all_dcs | System Get All Dcs Admin +*SystemApi* | [**system_get_all_kgs_admin**](docs/SystemApi.md#system_get_all_kgs_admin) | **GET** /system/admin/get_all_kgs | System Get All Kgs Admin +*SystemFlavoursApi* | [**delete_flavour**](docs/SystemFlavoursApi.md#delete_flavour) | **DELETE** /system/admin/delete_flavour/{flavour_name} | Delete Flavour +*SystemFlavoursApi* | [**get_flavour**](docs/SystemFlavoursApi.md#get_flavour) | **GET** /system/admin/get_flavour/{flavour_name} | Get Flavour +*SystemFlavoursApi* | [**list_all_flavours**](docs/SystemFlavoursApi.md#list_all_flavours) | **GET** /system/admin/list_all_flavours | List All Flavours +*SystemFlavoursApi* | [**list_flavours_by_project**](docs/SystemFlavoursApi.md#list_flavours_by_project) | **GET** /system/admin/get_project_flavours/{proj_key} | List Flavours By Project +*SystemFlavoursApi* | [**list_projects_flavours**](docs/SystemFlavoursApi.md#list_projects_flavours) | **GET** /system/admin/list_projects_flavours | List Projects Flavours +*SystemFlavoursApi* | [**save_flavour**](docs/SystemFlavoursApi.md#save_flavour) | **PUT** /system/admin/save_flavour | Save Flavour +*SystemFlavoursApi* | [**save_project_flavours**](docs/SystemFlavoursApi.md#save_project_flavours) | **PUT** /system/admin/save_project_flavours | Save Project Flavours +*SystemQuotasApi* | [**get_flavours_default_quotas**](docs/SystemQuotasApi.md#get_flavours_default_quotas) | **GET** /system/admin/get_flavours_default_quota | Get Flavours Default Quotas +*SystemQuotasApi* | [**get_project_flavour_total_kgs**](docs/SystemQuotasApi.md#get_project_flavour_total_kgs) | **GET** /system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name} | Get Project Flavour Total Kgs +*SystemQuotasApi* | [**get_project_flavours_quota**](docs/SystemQuotasApi.md#get_project_flavours_quota) | **GET** /system/admin/get_project_flavours_quota/{proj_key} | Get Project Flavours Quota +*SystemQuotasApi* | [**get_projects_flavours_quota**](docs/SystemQuotasApi.md#get_projects_flavours_quota) | **GET** /system/admin/get_projects_flavours_quota | Get Projects Flavours Quota +*SystemQuotasApi* | [**save_flavours_default_quotas**](docs/SystemQuotasApi.md#save_flavours_default_quotas) | **PUT** /system/admin/save_flavours_default_quota | Save Flavours Default Quotas +*SystemQuotasApi* | [**save_project_flavours_quota**](docs/SystemQuotasApi.md#save_project_flavours_quota) | **PUT** /system/admin/save_project_flavours_quota | Save Project Flavours Quota +*SystemSummaryApi* | [**system_get_cps_summary**](docs/SystemSummaryApi.md#system_get_cps_summary) | **GET** /system/admin/summary | System Get Cps Summary +*SystemSummaryApi* | [**system_get_dc_storage_summary_async**](docs/SystemSummaryApi.md#system_get_dc_storage_summary_async) | **GET** /system/admin/dc_storage_summary/{dc_key} | System Get Dc Storage Summary Async +*SystemSummaryApi* | [**system_get_kg_storage_summary_async**](docs/SystemSummaryApi.md#system_get_kg_storage_summary_async) | **GET** /system/admin/kg_storage_summary/{kg_key} | System Get Kg Storage Summary Async +*TasksApi* | [**abort_project_task**](docs/TasksApi.md#abort_project_task) | **POST** /project/{proj_key}/tasks/{task_id}/actions/abort | Abort Project Task +*TasksApi* | [**get_project_celery_task**](docs/TasksApi.md#get_project_celery_task) | **GET** /project/{proj_key}/celery_tasks/{task_id} | Get Project Celery Task +*TasksApi* | [**get_project_task**](docs/TasksApi.md#get_project_task) | **GET** /project/{proj_key}/tasks/{task_id} | Get Project Task +*TasksApi* | [**list_project_tasks**](docs/TasksApi.md#list_project_tasks) | **GET** /project/{proj_key}/tasks | List Project Tasks +*UploadApi* | [**create_project_scratch_file**](docs/UploadApi.md#create_project_scratch_file) | **POST** /project/{proj_key}/scratch/files/upload/{filename} | Create Project Scratch File +*UploadApi* | [**list_project_scratch_files**](docs/UploadApi.md#list_project_scratch_files) | **GET** /project/{proj_key}/scratch/files | List Project Scratch Files +*UploadApi* | [**list_project_scratch_files_paginated**](docs/UploadApi.md#list_project_scratch_files_paginated) | **GET** /project/{proj_key}/scratch/files_paginated | List Project Scratch Files Paginated + + +## Documentation For Models + + - [AssembleMode](docs/AssembleMode.md) + - [AssembleSettings](docs/AssembleSettings.md) + - [AttachmentUploadData](docs/AttachmentUploadData.md) + - [AttachmentUploadRequestBody](docs/AttachmentUploadRequestBody.md) + - [BagFlavourFullData](docs/BagFlavourFullData.md) + - [CCSProject](docs/CCSProject.md) + - [CPSPackage](docs/CPSPackage.md) + - [CPSSummary](docs/CPSSummary.md) + - [CcsTask](docs/CcsTask.md) + - [CollectionMetadataSettings](docs/CollectionMetadataSettings.md) + - [Config](docs/Config.md) + - [ConvertDocumentRequest](docs/ConvertDocumentRequest.md) + - [ConvertDocumentsRequestBody](docs/ConvertDocumentsRequestBody.md) + - [ConvertDocumentsSources](docs/ConvertDocumentsSources.md) + - [ConvertUploadDocumentsRequestBody](docs/ConvertUploadDocumentsRequestBody.md) + - [CpsTask](docs/CpsTask.md) + - [Data](docs/Data.md) + - [DataFlow](docs/DataFlow.md) + - [DataIndexUploadFileSource](docs/DataIndexUploadFileSource.md) + - [DefaultValues](docs/DefaultValues.md) + - [Deployment](docs/Deployment.md) + - [DirectModelConfig](docs/DirectModelConfig.md) + - [DocumentArtifacts](docs/DocumentArtifacts.md) + - [DocumentArtifactsItem](docs/DocumentArtifactsItem.md) + - [DocumentArtifactsPageItem](docs/DocumentArtifactsPageItem.md) + - [DocumentStatistics](docs/DocumentStatistics.md) + - [ElasticIndexPropertyObject](docs/ElasticIndexPropertyObject.md) + - [ElasticIndexPropertyPrimitive](docs/ElasticIndexPropertyPrimitive.md) + - [ElasticIndexSearchQueryOptions](docs/ElasticIndexSearchQueryOptions.md) + - [ElasticIndexSource](docs/ElasticIndexSource.md) + - [ElasticInstanceDataIndex](docs/ElasticInstanceDataIndex.md) + - [ElasticMetadata](docs/ElasticMetadata.md) + - [FileSource](docs/FileSource.md) + - [Flavour](docs/Flavour.md) + - [FlavoursDefaultQuota](docs/FlavoursDefaultQuota.md) + - [FlavoursQuota](docs/FlavoursQuota.md) + - [GenAIAWSBedrock](docs/GenAIAWSBedrock.md) + - [GenAIAWSBedrockConfig](docs/GenAIAWSBedrockConfig.md) + - [GenAIBAM](docs/GenAIBAM.md) + - [GenAIBAMConfig](docs/GenAIBAMConfig.md) + - [GenAIHFInferenceApi](docs/GenAIHFInferenceApi.md) + - [GenAIHFInferenceApiConfig](docs/GenAIHFInferenceApiConfig.md) + - [GenAIParams](docs/GenAIParams.md) + - [GenAIPartialParams](docs/GenAIPartialParams.md) + - [GenAIWatsonx](docs/GenAIWatsonx.md) + - [GenAIWatsonxConfig](docs/GenAIWatsonxConfig.md) + - [GroupedProjectDocuments](docs/GroupedProjectDocuments.md) + - [HTTPValidationError](docs/HTTPValidationError.md) + - [HttpSource](docs/HttpSource.md) + - [InternalUrl](docs/InternalUrl.md) + - [JsonUploadRequestBody](docs/JsonUploadRequestBody.md) + - [ListProjectFlavours](docs/ListProjectFlavours.md) + - [ModelPipelineSettings](docs/ModelPipelineSettings.md) + - [ModelPipelineSettingsClustersInner](docs/ModelPipelineSettingsClustersInner.md) + - [ModulesConfig](docs/ModulesConfig.md) + - [OcrSettings](docs/OcrSettings.md) + - [Package](docs/Package.md) + - [PartialDirectConversionParameters](docs/PartialDirectConversionParameters.md) + - [ProjectAgent](docs/ProjectAgent.md) + - [ProjectAgents](docs/ProjectAgents.md) + - [ProjectDataIndexNonView](docs/ProjectDataIndexNonView.md) + - [ProjectDataIndexSource](docs/ProjectDataIndexSource.md) + - [ProjectDataIndexView](docs/ProjectDataIndexView.md) + - [ProjectDataIndexWithStatus](docs/ProjectDataIndexWithStatus.md) + - [ProjectDocument](docs/ProjectDocument.md) + - [ProjectDocumentURL](docs/ProjectDocumentURL.md) + - [ProjectDocuments](docs/ProjectDocuments.md) + - [ProjectFlavourTotalKgs](docs/ProjectFlavourTotalKgs.md) + - [ProjectFlavoursQuota](docs/ProjectFlavoursQuota.md) + - [ProjectPackageInstalationManifest](docs/ProjectPackageInstalationManifest.md) + - [ProjectScratchFiles](docs/ProjectScratchFiles.md) + - [ProjectScratchFilesPaginated](docs/ProjectScratchFilesPaginated.md) + - [ProjectSourceDataIndex](docs/ProjectSourceDataIndex.md) + - [ProjectsFlavours](docs/ProjectsFlavours.md) + - [Properties](docs/Properties.md) + - [ReferenceToModel](docs/ReferenceToModel.md) + - [ResponseDocumentArtifacts](docs/ResponseDocumentArtifacts.md) + - [ResponseGetProjectIntegrationConfigGenai](docs/ResponseGetProjectIntegrationConfigGenai.md) + - [ResponseGroupedDocuments](docs/ResponseGroupedDocuments.md) + - [ResponseUploadJobs](docs/ResponseUploadJobs.md) + - [S3Coordinates](docs/S3Coordinates.md) + - [S3DocumentSource](docs/S3DocumentSource.md) + - [SemanticIngestReqParams](docs/SemanticIngestReqParams.md) + - [SemanticIngestRequest](docs/SemanticIngestRequest.md) + - [SemanticIngestSourcePrivateDataCollection](docs/SemanticIngestSourcePrivateDataCollection.md) + - [SemanticIngestSourcePrivateDataDocument](docs/SemanticIngestSourcePrivateDataDocument.md) + - [SemanticIngestSourcePublicDataDocument](docs/SemanticIngestSourcePublicDataDocument.md) + - [SemanticIngestSourceUrl](docs/SemanticIngestSourceUrl.md) + - [Source](docs/Source.md) + - [Source1](docs/Source1.md) + - [StorageSummaryTask](docs/StorageSummaryTask.md) + - [SystemInfo](docs/SystemInfo.md) + - [TargetConversionParameters](docs/TargetConversionParameters.md) + - [TaskContext](docs/TaskContext.md) + - [TaskResult](docs/TaskResult.md) + - [TemporaryUploadFileResult](docs/TemporaryUploadFileResult.md) + - [TemporaryUrl](docs/TemporaryUrl.md) + - [TemporaryUrlFields](docs/TemporaryUrlFields.md) + - [TokenResponse](docs/TokenResponse.md) + - [UploadDate](docs/UploadDate.md) + - [UploadElasticRequestBody](docs/UploadElasticRequestBody.md) + - [UploadJob](docs/UploadJob.md) + - [Urls](docs/Urls.md) + - [ValidationError](docs/ValidationError.md) + - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md) + - [ViewOf](docs/ViewOf.md) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### Bearer + +- **Type**: API key +- **API key parameter name**: Authorization +- **Location**: HTTP header + + +## Author + + + + diff --git a/docs/apis/public_v2/AssembleMode.md b/docs/apis/public_v2/docs/AssembleMode.md similarity index 100% rename from docs/apis/public_v2/AssembleMode.md rename to docs/apis/public_v2/docs/AssembleMode.md diff --git a/docs/apis/public_v2/AssembleSettings.md b/docs/apis/public_v2/docs/AssembleSettings.md similarity index 100% rename from docs/apis/public_v2/AssembleSettings.md rename to docs/apis/public_v2/docs/AssembleSettings.md diff --git a/docs/apis/public_v2/AttachmentUploadData.md b/docs/apis/public_v2/docs/AttachmentUploadData.md similarity index 100% rename from docs/apis/public_v2/AttachmentUploadData.md rename to docs/apis/public_v2/docs/AttachmentUploadData.md diff --git a/docs/apis/public_v2/AttachmentUploadRequestBody.md b/docs/apis/public_v2/docs/AttachmentUploadRequestBody.md similarity index 100% rename from docs/apis/public_v2/AttachmentUploadRequestBody.md rename to docs/apis/public_v2/docs/AttachmentUploadRequestBody.md diff --git a/docs/apis/public_v2/BagFlavourFullData.md b/docs/apis/public_v2/docs/BagFlavourFullData.md similarity index 100% rename from docs/apis/public_v2/BagFlavourFullData.md rename to docs/apis/public_v2/docs/BagFlavourFullData.md diff --git a/docs/apis/public_v2/CCSProject.md b/docs/apis/public_v2/docs/CCSProject.md similarity index 100% rename from docs/apis/public_v2/CCSProject.md rename to docs/apis/public_v2/docs/CCSProject.md diff --git a/docs/apis/public_v2/CPSPackage.md b/docs/apis/public_v2/docs/CPSPackage.md similarity index 100% rename from docs/apis/public_v2/CPSPackage.md rename to docs/apis/public_v2/docs/CPSPackage.md diff --git a/docs/apis/public_v2/CPSSummary.md b/docs/apis/public_v2/docs/CPSSummary.md similarity index 100% rename from docs/apis/public_v2/CPSSummary.md rename to docs/apis/public_v2/docs/CPSSummary.md diff --git a/docs/apis/public_v2/CcsTask.md b/docs/apis/public_v2/docs/CcsTask.md similarity index 100% rename from docs/apis/public_v2/CcsTask.md rename to docs/apis/public_v2/docs/CcsTask.md diff --git a/docs/apis/public_v2/CollectionMetadataSettings.md b/docs/apis/public_v2/docs/CollectionMetadataSettings.md similarity index 100% rename from docs/apis/public_v2/CollectionMetadataSettings.md rename to docs/apis/public_v2/docs/CollectionMetadataSettings.md diff --git a/docs/apis/public_v2/Config.md b/docs/apis/public_v2/docs/Config.md similarity index 100% rename from docs/apis/public_v2/Config.md rename to docs/apis/public_v2/docs/Config.md diff --git a/docs/apis/public_v2/ContentManagerApi.md b/docs/apis/public_v2/docs/ContentManagerApi.md similarity index 100% rename from docs/apis/public_v2/ContentManagerApi.md rename to docs/apis/public_v2/docs/ContentManagerApi.md diff --git a/docs/apis/public_v2/ConvertDocumentRequest.md b/docs/apis/public_v2/docs/ConvertDocumentRequest.md similarity index 100% rename from docs/apis/public_v2/ConvertDocumentRequest.md rename to docs/apis/public_v2/docs/ConvertDocumentRequest.md diff --git a/docs/apis/public_v2/ConvertDocumentsRequestBody.md b/docs/apis/public_v2/docs/ConvertDocumentsRequestBody.md similarity index 100% rename from docs/apis/public_v2/ConvertDocumentsRequestBody.md rename to docs/apis/public_v2/docs/ConvertDocumentsRequestBody.md diff --git a/docs/apis/public_v2/ConvertDocumentsSources.md b/docs/apis/public_v2/docs/ConvertDocumentsSources.md similarity index 100% rename from docs/apis/public_v2/ConvertDocumentsSources.md rename to docs/apis/public_v2/docs/ConvertDocumentsSources.md diff --git a/docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md b/docs/apis/public_v2/docs/ConvertUploadDocumentsRequestBody.md similarity index 100% rename from docs/apis/public_v2/ConvertUploadDocumentsRequestBody.md rename to docs/apis/public_v2/docs/ConvertUploadDocumentsRequestBody.md diff --git a/docs/apis/public_v2/CpsTask.md b/docs/apis/public_v2/docs/CpsTask.md similarity index 100% rename from docs/apis/public_v2/CpsTask.md rename to docs/apis/public_v2/docs/CpsTask.md diff --git a/docs/apis/public_v2/Data.md b/docs/apis/public_v2/docs/Data.md similarity index 100% rename from docs/apis/public_v2/Data.md rename to docs/apis/public_v2/docs/Data.md diff --git a/docs/apis/public_v2/DataFlow.md b/docs/apis/public_v2/docs/DataFlow.md similarity index 100% rename from docs/apis/public_v2/DataFlow.md rename to docs/apis/public_v2/docs/DataFlow.md diff --git a/docs/apis/public_v2/DataIndexUploadFileSource.md b/docs/apis/public_v2/docs/DataIndexUploadFileSource.md similarity index 100% rename from docs/apis/public_v2/DataIndexUploadFileSource.md rename to docs/apis/public_v2/docs/DataIndexUploadFileSource.md diff --git a/docs/apis/public_v2/DataIndicesApi.md b/docs/apis/public_v2/docs/DataIndicesApi.md similarity index 100% rename from docs/apis/public_v2/DataIndicesApi.md rename to docs/apis/public_v2/docs/DataIndicesApi.md diff --git a/docs/apis/public_v2/DataIndicesUploadApi.md b/docs/apis/public_v2/docs/DataIndicesUploadApi.md similarity index 100% rename from docs/apis/public_v2/DataIndicesUploadApi.md rename to docs/apis/public_v2/docs/DataIndicesUploadApi.md diff --git a/docs/apis/public_v2/DefaultValues.md b/docs/apis/public_v2/docs/DefaultValues.md similarity index 100% rename from docs/apis/public_v2/DefaultValues.md rename to docs/apis/public_v2/docs/DefaultValues.md diff --git a/docs/apis/public_v2/Deployment.md b/docs/apis/public_v2/docs/Deployment.md similarity index 100% rename from docs/apis/public_v2/Deployment.md rename to docs/apis/public_v2/docs/Deployment.md diff --git a/docs/apis/public_v2/DirectModelConfig.md b/docs/apis/public_v2/docs/DirectModelConfig.md similarity index 100% rename from docs/apis/public_v2/DirectModelConfig.md rename to docs/apis/public_v2/docs/DirectModelConfig.md diff --git a/docs/apis/public_v2/DocumentArtifacts.md b/docs/apis/public_v2/docs/DocumentArtifacts.md similarity index 100% rename from docs/apis/public_v2/DocumentArtifacts.md rename to docs/apis/public_v2/docs/DocumentArtifacts.md diff --git a/docs/apis/public_v2/DocumentArtifactsItem.md b/docs/apis/public_v2/docs/DocumentArtifactsItem.md similarity index 100% rename from docs/apis/public_v2/DocumentArtifactsItem.md rename to docs/apis/public_v2/docs/DocumentArtifactsItem.md diff --git a/docs/apis/public_v2/DocumentArtifactsPageItem.md b/docs/apis/public_v2/docs/DocumentArtifactsPageItem.md similarity index 100% rename from docs/apis/public_v2/DocumentArtifactsPageItem.md rename to docs/apis/public_v2/docs/DocumentArtifactsPageItem.md diff --git a/docs/apis/public_v2/DocumentStatistics.md b/docs/apis/public_v2/docs/DocumentStatistics.md similarity index 100% rename from docs/apis/public_v2/DocumentStatistics.md rename to docs/apis/public_v2/docs/DocumentStatistics.md diff --git a/docs/apis/public_v2/ElasticIndexPropertyObject.md b/docs/apis/public_v2/docs/ElasticIndexPropertyObject.md similarity index 100% rename from docs/apis/public_v2/ElasticIndexPropertyObject.md rename to docs/apis/public_v2/docs/ElasticIndexPropertyObject.md diff --git a/docs/apis/public_v2/ElasticIndexPropertyPrimitive.md b/docs/apis/public_v2/docs/ElasticIndexPropertyPrimitive.md similarity index 100% rename from docs/apis/public_v2/ElasticIndexPropertyPrimitive.md rename to docs/apis/public_v2/docs/ElasticIndexPropertyPrimitive.md diff --git a/docs/apis/public_v2/ElasticIndexSearchQueryOptions.md b/docs/apis/public_v2/docs/ElasticIndexSearchQueryOptions.md similarity index 100% rename from docs/apis/public_v2/ElasticIndexSearchQueryOptions.md rename to docs/apis/public_v2/docs/ElasticIndexSearchQueryOptions.md diff --git a/docs/apis/public_v2/ElasticIndexSource.md b/docs/apis/public_v2/docs/ElasticIndexSource.md similarity index 100% rename from docs/apis/public_v2/ElasticIndexSource.md rename to docs/apis/public_v2/docs/ElasticIndexSource.md diff --git a/docs/apis/public_v2/ElasticInstanceDataIndex.md b/docs/apis/public_v2/docs/ElasticInstanceDataIndex.md similarity index 100% rename from docs/apis/public_v2/ElasticInstanceDataIndex.md rename to docs/apis/public_v2/docs/ElasticInstanceDataIndex.md diff --git a/docs/apis/public_v2/ElasticMetadata.md b/docs/apis/public_v2/docs/ElasticMetadata.md similarity index 100% rename from docs/apis/public_v2/ElasticMetadata.md rename to docs/apis/public_v2/docs/ElasticMetadata.md diff --git a/docs/apis/public_v2/FileSource.md b/docs/apis/public_v2/docs/FileSource.md similarity index 100% rename from docs/apis/public_v2/FileSource.md rename to docs/apis/public_v2/docs/FileSource.md diff --git a/docs/apis/public_v2/Flavour.md b/docs/apis/public_v2/docs/Flavour.md similarity index 100% rename from docs/apis/public_v2/Flavour.md rename to docs/apis/public_v2/docs/Flavour.md diff --git a/docs/apis/public_v2/FlavoursDefaultQuota.md b/docs/apis/public_v2/docs/FlavoursDefaultQuota.md similarity index 100% rename from docs/apis/public_v2/FlavoursDefaultQuota.md rename to docs/apis/public_v2/docs/FlavoursDefaultQuota.md diff --git a/docs/apis/public_v2/FlavoursQuota.md b/docs/apis/public_v2/docs/FlavoursQuota.md similarity index 100% rename from docs/apis/public_v2/FlavoursQuota.md rename to docs/apis/public_v2/docs/FlavoursQuota.md diff --git a/docs/apis/public_v2/GenAIAWSBedrock.md b/docs/apis/public_v2/docs/GenAIAWSBedrock.md similarity index 100% rename from docs/apis/public_v2/GenAIAWSBedrock.md rename to docs/apis/public_v2/docs/GenAIAWSBedrock.md diff --git a/docs/apis/public_v2/GenAIAWSBedrockConfig.md b/docs/apis/public_v2/docs/GenAIAWSBedrockConfig.md similarity index 100% rename from docs/apis/public_v2/GenAIAWSBedrockConfig.md rename to docs/apis/public_v2/docs/GenAIAWSBedrockConfig.md diff --git a/docs/apis/public_v2/GenAIBAM.md b/docs/apis/public_v2/docs/GenAIBAM.md similarity index 100% rename from docs/apis/public_v2/GenAIBAM.md rename to docs/apis/public_v2/docs/GenAIBAM.md diff --git a/docs/apis/public_v2/GenAIBAMConfig.md b/docs/apis/public_v2/docs/GenAIBAMConfig.md similarity index 100% rename from docs/apis/public_v2/GenAIBAMConfig.md rename to docs/apis/public_v2/docs/GenAIBAMConfig.md diff --git a/docs/apis/public_v2/GenAIHFInferenceApi.md b/docs/apis/public_v2/docs/GenAIHFInferenceApi.md similarity index 100% rename from docs/apis/public_v2/GenAIHFInferenceApi.md rename to docs/apis/public_v2/docs/GenAIHFInferenceApi.md diff --git a/docs/apis/public_v2/GenAIHFInferenceApiConfig.md b/docs/apis/public_v2/docs/GenAIHFInferenceApiConfig.md similarity index 100% rename from docs/apis/public_v2/GenAIHFInferenceApiConfig.md rename to docs/apis/public_v2/docs/GenAIHFInferenceApiConfig.md diff --git a/docs/apis/public_v2/GenAIParams.md b/docs/apis/public_v2/docs/GenAIParams.md similarity index 100% rename from docs/apis/public_v2/GenAIParams.md rename to docs/apis/public_v2/docs/GenAIParams.md diff --git a/docs/apis/public_v2/GenAIPartialParams.md b/docs/apis/public_v2/docs/GenAIPartialParams.md similarity index 100% rename from docs/apis/public_v2/GenAIPartialParams.md rename to docs/apis/public_v2/docs/GenAIPartialParams.md diff --git a/docs/apis/public_v2/GenAIWatsonx.md b/docs/apis/public_v2/docs/GenAIWatsonx.md similarity index 100% rename from docs/apis/public_v2/GenAIWatsonx.md rename to docs/apis/public_v2/docs/GenAIWatsonx.md diff --git a/docs/apis/public_v2/GenAIWatsonxConfig.md b/docs/apis/public_v2/docs/GenAIWatsonxConfig.md similarity index 100% rename from docs/apis/public_v2/GenAIWatsonxConfig.md rename to docs/apis/public_v2/docs/GenAIWatsonxConfig.md diff --git a/docs/apis/public_v2/GroupedProjectDocuments.md b/docs/apis/public_v2/docs/GroupedProjectDocuments.md similarity index 100% rename from docs/apis/public_v2/GroupedProjectDocuments.md rename to docs/apis/public_v2/docs/GroupedProjectDocuments.md diff --git a/docs/apis/public_v2/HTTPValidationError.md b/docs/apis/public_v2/docs/HTTPValidationError.md similarity index 100% rename from docs/apis/public_v2/HTTPValidationError.md rename to docs/apis/public_v2/docs/HTTPValidationError.md diff --git a/docs/apis/public_v2/HttpSource.md b/docs/apis/public_v2/docs/HttpSource.md similarity index 100% rename from docs/apis/public_v2/HttpSource.md rename to docs/apis/public_v2/docs/HttpSource.md diff --git a/docs/apis/public_v2/InternalUrl.md b/docs/apis/public_v2/docs/InternalUrl.md similarity index 100% rename from docs/apis/public_v2/InternalUrl.md rename to docs/apis/public_v2/docs/InternalUrl.md diff --git a/docs/apis/public_v2/JsonUploadRequestBody.md b/docs/apis/public_v2/docs/JsonUploadRequestBody.md similarity index 100% rename from docs/apis/public_v2/JsonUploadRequestBody.md rename to docs/apis/public_v2/docs/JsonUploadRequestBody.md diff --git a/docs/apis/public_v2/KnowledgeGraphsApi.md b/docs/apis/public_v2/docs/KnowledgeGraphsApi.md similarity index 100% rename from docs/apis/public_v2/KnowledgeGraphsApi.md rename to docs/apis/public_v2/docs/KnowledgeGraphsApi.md diff --git a/docs/apis/public_v2/ListProjectFlavours.md b/docs/apis/public_v2/docs/ListProjectFlavours.md similarity index 100% rename from docs/apis/public_v2/ListProjectFlavours.md rename to docs/apis/public_v2/docs/ListProjectFlavours.md diff --git a/docs/apis/public_v2/ModelPipelineSettings.md b/docs/apis/public_v2/docs/ModelPipelineSettings.md similarity index 100% rename from docs/apis/public_v2/ModelPipelineSettings.md rename to docs/apis/public_v2/docs/ModelPipelineSettings.md diff --git a/docs/apis/public_v2/ModelPipelineSettingsClustersInner.md b/docs/apis/public_v2/docs/ModelPipelineSettingsClustersInner.md similarity index 100% rename from docs/apis/public_v2/ModelPipelineSettingsClustersInner.md rename to docs/apis/public_v2/docs/ModelPipelineSettingsClustersInner.md diff --git a/docs/apis/public_v2/ModulesConfig.md b/docs/apis/public_v2/docs/ModulesConfig.md similarity index 100% rename from docs/apis/public_v2/ModulesConfig.md rename to docs/apis/public_v2/docs/ModulesConfig.md diff --git a/docs/apis/public_v2/OcrSettings.md b/docs/apis/public_v2/docs/OcrSettings.md similarity index 100% rename from docs/apis/public_v2/OcrSettings.md rename to docs/apis/public_v2/docs/OcrSettings.md diff --git a/docs/apis/public_v2/Package.md b/docs/apis/public_v2/docs/Package.md similarity index 100% rename from docs/apis/public_v2/Package.md rename to docs/apis/public_v2/docs/Package.md diff --git a/docs/apis/public_v2/PartialDirectConversionParameters.md b/docs/apis/public_v2/docs/PartialDirectConversionParameters.md similarity index 100% rename from docs/apis/public_v2/PartialDirectConversionParameters.md rename to docs/apis/public_v2/docs/PartialDirectConversionParameters.md diff --git a/docs/apis/public_v2/ProjectAgent.md b/docs/apis/public_v2/docs/ProjectAgent.md similarity index 100% rename from docs/apis/public_v2/ProjectAgent.md rename to docs/apis/public_v2/docs/ProjectAgent.md diff --git a/docs/apis/public_v2/ProjectAgents.md b/docs/apis/public_v2/docs/ProjectAgents.md similarity index 100% rename from docs/apis/public_v2/ProjectAgents.md rename to docs/apis/public_v2/docs/ProjectAgents.md diff --git a/docs/apis/public_v2/ProjectApi.md b/docs/apis/public_v2/docs/ProjectApi.md similarity index 100% rename from docs/apis/public_v2/ProjectApi.md rename to docs/apis/public_v2/docs/ProjectApi.md diff --git a/docs/apis/public_v2/ProjectDataIndexNonView.md b/docs/apis/public_v2/docs/ProjectDataIndexNonView.md similarity index 100% rename from docs/apis/public_v2/ProjectDataIndexNonView.md rename to docs/apis/public_v2/docs/ProjectDataIndexNonView.md diff --git a/docs/apis/public_v2/ProjectDataIndexSource.md b/docs/apis/public_v2/docs/ProjectDataIndexSource.md similarity index 100% rename from docs/apis/public_v2/ProjectDataIndexSource.md rename to docs/apis/public_v2/docs/ProjectDataIndexSource.md diff --git a/docs/apis/public_v2/ProjectDataIndexView.md b/docs/apis/public_v2/docs/ProjectDataIndexView.md similarity index 100% rename from docs/apis/public_v2/ProjectDataIndexView.md rename to docs/apis/public_v2/docs/ProjectDataIndexView.md diff --git a/docs/apis/public_v2/ProjectDataIndexWithStatus.md b/docs/apis/public_v2/docs/ProjectDataIndexWithStatus.md similarity index 100% rename from docs/apis/public_v2/ProjectDataIndexWithStatus.md rename to docs/apis/public_v2/docs/ProjectDataIndexWithStatus.md diff --git a/docs/apis/public_v2/ProjectDocument.md b/docs/apis/public_v2/docs/ProjectDocument.md similarity index 100% rename from docs/apis/public_v2/ProjectDocument.md rename to docs/apis/public_v2/docs/ProjectDocument.md diff --git a/docs/apis/public_v2/ProjectDocumentURL.md b/docs/apis/public_v2/docs/ProjectDocumentURL.md similarity index 100% rename from docs/apis/public_v2/ProjectDocumentURL.md rename to docs/apis/public_v2/docs/ProjectDocumentURL.md diff --git a/docs/apis/public_v2/ProjectDocuments.md b/docs/apis/public_v2/docs/ProjectDocuments.md similarity index 100% rename from docs/apis/public_v2/ProjectDocuments.md rename to docs/apis/public_v2/docs/ProjectDocuments.md diff --git a/docs/apis/public_v2/ProjectFlavourTotalKgs.md b/docs/apis/public_v2/docs/ProjectFlavourTotalKgs.md similarity index 100% rename from docs/apis/public_v2/ProjectFlavourTotalKgs.md rename to docs/apis/public_v2/docs/ProjectFlavourTotalKgs.md diff --git a/docs/apis/public_v2/ProjectFlavoursQuota.md b/docs/apis/public_v2/docs/ProjectFlavoursQuota.md similarity index 100% rename from docs/apis/public_v2/ProjectFlavoursQuota.md rename to docs/apis/public_v2/docs/ProjectFlavoursQuota.md diff --git a/docs/apis/public_v2/ProjectPackageInstalationManifest.md b/docs/apis/public_v2/docs/ProjectPackageInstalationManifest.md similarity index 100% rename from docs/apis/public_v2/ProjectPackageInstalationManifest.md rename to docs/apis/public_v2/docs/ProjectPackageInstalationManifest.md diff --git a/docs/apis/public_v2/ProjectScratchFiles.md b/docs/apis/public_v2/docs/ProjectScratchFiles.md similarity index 100% rename from docs/apis/public_v2/ProjectScratchFiles.md rename to docs/apis/public_v2/docs/ProjectScratchFiles.md diff --git a/docs/apis/public_v2/ProjectScratchFilesPaginated.md b/docs/apis/public_v2/docs/ProjectScratchFilesPaginated.md similarity index 100% rename from docs/apis/public_v2/ProjectScratchFilesPaginated.md rename to docs/apis/public_v2/docs/ProjectScratchFilesPaginated.md diff --git a/docs/apis/public_v2/ProjectSourceDataIndex.md b/docs/apis/public_v2/docs/ProjectSourceDataIndex.md similarity index 100% rename from docs/apis/public_v2/ProjectSourceDataIndex.md rename to docs/apis/public_v2/docs/ProjectSourceDataIndex.md diff --git a/docs/apis/public_v2/ProjectsFlavours.md b/docs/apis/public_v2/docs/ProjectsFlavours.md similarity index 100% rename from docs/apis/public_v2/ProjectsFlavours.md rename to docs/apis/public_v2/docs/ProjectsFlavours.md diff --git a/docs/apis/public_v2/Properties.md b/docs/apis/public_v2/docs/Properties.md similarity index 100% rename from docs/apis/public_v2/Properties.md rename to docs/apis/public_v2/docs/Properties.md diff --git a/docs/apis/public_v2/ReferenceToModel.md b/docs/apis/public_v2/docs/ReferenceToModel.md similarity index 100% rename from docs/apis/public_v2/ReferenceToModel.md rename to docs/apis/public_v2/docs/ReferenceToModel.md diff --git a/docs/apis/public_v2/ResponseDocumentArtifacts.md b/docs/apis/public_v2/docs/ResponseDocumentArtifacts.md similarity index 100% rename from docs/apis/public_v2/ResponseDocumentArtifacts.md rename to docs/apis/public_v2/docs/ResponseDocumentArtifacts.md diff --git a/docs/apis/public_v2/ResponseGetProjectIntegrationConfigGenai.md b/docs/apis/public_v2/docs/ResponseGetProjectIntegrationConfigGenai.md similarity index 100% rename from docs/apis/public_v2/ResponseGetProjectIntegrationConfigGenai.md rename to docs/apis/public_v2/docs/ResponseGetProjectIntegrationConfigGenai.md diff --git a/docs/apis/public_v2/ResponseGroupedDocuments.md b/docs/apis/public_v2/docs/ResponseGroupedDocuments.md similarity index 100% rename from docs/apis/public_v2/ResponseGroupedDocuments.md rename to docs/apis/public_v2/docs/ResponseGroupedDocuments.md diff --git a/docs/apis/public_v2/ResponseUploadJobs.md b/docs/apis/public_v2/docs/ResponseUploadJobs.md similarity index 100% rename from docs/apis/public_v2/ResponseUploadJobs.md rename to docs/apis/public_v2/docs/ResponseUploadJobs.md diff --git a/docs/apis/public_v2/S3Coordinates.md b/docs/apis/public_v2/docs/S3Coordinates.md similarity index 100% rename from docs/apis/public_v2/S3Coordinates.md rename to docs/apis/public_v2/docs/S3Coordinates.md diff --git a/docs/apis/public_v2/S3DocumentSource.md b/docs/apis/public_v2/docs/S3DocumentSource.md similarity index 100% rename from docs/apis/public_v2/S3DocumentSource.md rename to docs/apis/public_v2/docs/S3DocumentSource.md diff --git a/docs/apis/public_v2/SemanticApi.md b/docs/apis/public_v2/docs/SemanticApi.md similarity index 100% rename from docs/apis/public_v2/SemanticApi.md rename to docs/apis/public_v2/docs/SemanticApi.md diff --git a/docs/apis/public_v2/SemanticIngestReqParams.md b/docs/apis/public_v2/docs/SemanticIngestReqParams.md similarity index 100% rename from docs/apis/public_v2/SemanticIngestReqParams.md rename to docs/apis/public_v2/docs/SemanticIngestReqParams.md diff --git a/docs/apis/public_v2/SemanticIngestRequest.md b/docs/apis/public_v2/docs/SemanticIngestRequest.md similarity index 100% rename from docs/apis/public_v2/SemanticIngestRequest.md rename to docs/apis/public_v2/docs/SemanticIngestRequest.md diff --git a/docs/apis/public_v2/SemanticIngestSourcePrivateDataCollection.md b/docs/apis/public_v2/docs/SemanticIngestSourcePrivateDataCollection.md similarity index 100% rename from docs/apis/public_v2/SemanticIngestSourcePrivateDataCollection.md rename to docs/apis/public_v2/docs/SemanticIngestSourcePrivateDataCollection.md diff --git a/docs/apis/public_v2/SemanticIngestSourcePrivateDataDocument.md b/docs/apis/public_v2/docs/SemanticIngestSourcePrivateDataDocument.md similarity index 100% rename from docs/apis/public_v2/SemanticIngestSourcePrivateDataDocument.md rename to docs/apis/public_v2/docs/SemanticIngestSourcePrivateDataDocument.md diff --git a/docs/apis/public_v2/SemanticIngestSourcePublicDataDocument.md b/docs/apis/public_v2/docs/SemanticIngestSourcePublicDataDocument.md similarity index 100% rename from docs/apis/public_v2/SemanticIngestSourcePublicDataDocument.md rename to docs/apis/public_v2/docs/SemanticIngestSourcePublicDataDocument.md diff --git a/docs/apis/public_v2/SemanticIngestSourceUrl.md b/docs/apis/public_v2/docs/SemanticIngestSourceUrl.md similarity index 100% rename from docs/apis/public_v2/SemanticIngestSourceUrl.md rename to docs/apis/public_v2/docs/SemanticIngestSourceUrl.md diff --git a/docs/apis/public_v2/Source.md b/docs/apis/public_v2/docs/Source.md similarity index 100% rename from docs/apis/public_v2/Source.md rename to docs/apis/public_v2/docs/Source.md diff --git a/docs/apis/public_v2/Source1.md b/docs/apis/public_v2/docs/Source1.md similarity index 100% rename from docs/apis/public_v2/Source1.md rename to docs/apis/public_v2/docs/Source1.md diff --git a/docs/apis/public_v2/StorageSummaryTask.md b/docs/apis/public_v2/docs/StorageSummaryTask.md similarity index 100% rename from docs/apis/public_v2/StorageSummaryTask.md rename to docs/apis/public_v2/docs/StorageSummaryTask.md diff --git a/docs/apis/public_v2/SystemApi.md b/docs/apis/public_v2/docs/SystemApi.md similarity index 100% rename from docs/apis/public_v2/SystemApi.md rename to docs/apis/public_v2/docs/SystemApi.md diff --git a/docs/apis/public_v2/SystemFlavoursApi.md b/docs/apis/public_v2/docs/SystemFlavoursApi.md similarity index 100% rename from docs/apis/public_v2/SystemFlavoursApi.md rename to docs/apis/public_v2/docs/SystemFlavoursApi.md diff --git a/docs/apis/public_v2/SystemInfo.md b/docs/apis/public_v2/docs/SystemInfo.md similarity index 100% rename from docs/apis/public_v2/SystemInfo.md rename to docs/apis/public_v2/docs/SystemInfo.md diff --git a/docs/apis/public_v2/SystemQuotasApi.md b/docs/apis/public_v2/docs/SystemQuotasApi.md similarity index 100% rename from docs/apis/public_v2/SystemQuotasApi.md rename to docs/apis/public_v2/docs/SystemQuotasApi.md diff --git a/docs/apis/public_v2/SystemSummaryApi.md b/docs/apis/public_v2/docs/SystemSummaryApi.md similarity index 100% rename from docs/apis/public_v2/SystemSummaryApi.md rename to docs/apis/public_v2/docs/SystemSummaryApi.md diff --git a/docs/apis/public_v2/TargetConversionParameters.md b/docs/apis/public_v2/docs/TargetConversionParameters.md similarity index 100% rename from docs/apis/public_v2/TargetConversionParameters.md rename to docs/apis/public_v2/docs/TargetConversionParameters.md diff --git a/docs/apis/public_v2/TaskContext.md b/docs/apis/public_v2/docs/TaskContext.md similarity index 100% rename from docs/apis/public_v2/TaskContext.md rename to docs/apis/public_v2/docs/TaskContext.md diff --git a/docs/apis/public_v2/TaskResult.md b/docs/apis/public_v2/docs/TaskResult.md similarity index 100% rename from docs/apis/public_v2/TaskResult.md rename to docs/apis/public_v2/docs/TaskResult.md diff --git a/docs/apis/public_v2/TasksApi.md b/docs/apis/public_v2/docs/TasksApi.md similarity index 100% rename from docs/apis/public_v2/TasksApi.md rename to docs/apis/public_v2/docs/TasksApi.md diff --git a/docs/apis/public_v2/TemporaryUploadFileResult.md b/docs/apis/public_v2/docs/TemporaryUploadFileResult.md similarity index 100% rename from docs/apis/public_v2/TemporaryUploadFileResult.md rename to docs/apis/public_v2/docs/TemporaryUploadFileResult.md diff --git a/docs/apis/public_v2/TemporaryUrl.md b/docs/apis/public_v2/docs/TemporaryUrl.md similarity index 100% rename from docs/apis/public_v2/TemporaryUrl.md rename to docs/apis/public_v2/docs/TemporaryUrl.md diff --git a/docs/apis/public_v2/TemporaryUrlFields.md b/docs/apis/public_v2/docs/TemporaryUrlFields.md similarity index 100% rename from docs/apis/public_v2/TemporaryUrlFields.md rename to docs/apis/public_v2/docs/TemporaryUrlFields.md diff --git a/docs/apis/public_v2/TokenResponse.md b/docs/apis/public_v2/docs/TokenResponse.md similarity index 100% rename from docs/apis/public_v2/TokenResponse.md rename to docs/apis/public_v2/docs/TokenResponse.md diff --git a/docs/apis/public_v2/UploadApi.md b/docs/apis/public_v2/docs/UploadApi.md similarity index 100% rename from docs/apis/public_v2/UploadApi.md rename to docs/apis/public_v2/docs/UploadApi.md diff --git a/docs/apis/public_v2/UploadDate.md b/docs/apis/public_v2/docs/UploadDate.md similarity index 100% rename from docs/apis/public_v2/UploadDate.md rename to docs/apis/public_v2/docs/UploadDate.md diff --git a/docs/apis/public_v2/UploadElasticRequestBody.md b/docs/apis/public_v2/docs/UploadElasticRequestBody.md similarity index 100% rename from docs/apis/public_v2/UploadElasticRequestBody.md rename to docs/apis/public_v2/docs/UploadElasticRequestBody.md diff --git a/docs/apis/public_v2/UploadJob.md b/docs/apis/public_v2/docs/UploadJob.md similarity index 100% rename from docs/apis/public_v2/UploadJob.md rename to docs/apis/public_v2/docs/UploadJob.md diff --git a/docs/apis/public_v2/Urls.md b/docs/apis/public_v2/docs/Urls.md similarity index 100% rename from docs/apis/public_v2/Urls.md rename to docs/apis/public_v2/docs/Urls.md diff --git a/docs/apis/public_v2/ValidationError.md b/docs/apis/public_v2/docs/ValidationError.md similarity index 100% rename from docs/apis/public_v2/ValidationError.md rename to docs/apis/public_v2/docs/ValidationError.md diff --git a/docs/apis/public_v2/ValidationErrorLocInner.md b/docs/apis/public_v2/docs/ValidationErrorLocInner.md similarity index 100% rename from docs/apis/public_v2/ValidationErrorLocInner.md rename to docs/apis/public_v2/docs/ValidationErrorLocInner.md diff --git a/docs/apis/public_v2/ViewOf.md b/docs/apis/public_v2/docs/ViewOf.md similarity index 100% rename from docs/apis/public_v2/ViewOf.md rename to docs/apis/public_v2/docs/ViewOf.md diff --git a/mkdocs.yml b/mkdocs.yml index 73361cc6..33c4e591 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,8 +63,8 @@ nav: - API reference: - Toolkit reference: api-reference.md - OpenAPI: - - User API: apis/user/UserApi.md # TODO we should point to the main index of the generated docs, but this is currently missing - - Public API: apis/public/KnowledgeGraphsApi.md # TODO we should point to the main index of the generated docs, but this is currently missing + # - User API: apis/user/UserApi.md # TODO we should point to the main index of the generated docs, but this is currently missing + - Public API: apis/public_v2/ # TODO we should point to the main index of the generated docs, but this is currently missing - CLI reference: cli-reference.md # Copyright @@ -112,8 +112,8 @@ markdown_extensions: - pymdownx.critic - pymdownx.details - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.keys - pymdownx.mark - pymdownx.smartsymbols diff --git a/poetry.lock b/poetry.lock index 5f26d125..13b458ea 100644 --- a/poetry.lock +++ b/poetry.lock @@ -83,40 +83,76 @@ docs = ["cogapp", "furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphi tests = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] tests-mypy = ["mypy (>=1.11.1)", "pytest-mypy-plugins"] +[[package]] +name = "babel" +version = "2.15.0" +description = "Internationalization utilities" +optional = false +python-versions = ">=3.8" +files = [ + {file = "Babel-2.15.0-py3-none-any.whl", hash = "sha256:08706bdad8d0a3413266ab61bd6c34d0c28d6e1e7badf40a2cebe67644e2e1fb"}, + {file = "babel-2.15.0.tar.gz", hash = "sha256:8daf0e265d05768bc6c7a314cf1321e9a123afc328cc635c18622a2f30a04413"}, +] + +[package.extras] +dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"] + +[[package]] +name = "backports-strenum" +version = "1.3.1" +description = "Base class for creating enumerated constants that are also subclasses of str" +optional = false +python-versions = ">=3.8.6,<3.11" +files = [ + {file = "backports_strenum-1.3.1-py3-none-any.whl", hash = "sha256:cdcfe36dc897e2615dc793b7d3097f54d359918fc448754a517e6f23044ccf83"}, + {file = "backports_strenum-1.3.1.tar.gz", hash = "sha256:77c52407342898497714f0596e86188bb7084f89063226f4ba66863482f42414"}, +] + [[package]] name = "black" -version = "22.12.0" +version = "24.8.0" description = "The uncompromising code formatter." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "black-22.12.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9eedd20838bd5d75b80c9f5487dbcb06836a43833a37846cf1d8c1cc01cef59d"}, - {file = "black-22.12.0-cp310-cp310-win_amd64.whl", hash = "sha256:159a46a4947f73387b4d83e87ea006dbb2337eab6c879620a3ba52699b1f4351"}, - {file = "black-22.12.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d30b212bffeb1e252b31dd269dfae69dd17e06d92b87ad26e23890f3efea366f"}, - {file = "black-22.12.0-cp311-cp311-win_amd64.whl", hash = "sha256:7412e75863aa5c5411886804678b7d083c7c28421210180d67dfd8cf1221e1f4"}, - {file = "black-22.12.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c116eed0efb9ff870ded8b62fe9f28dd61ef6e9ddd28d83d7d264a38417dcee2"}, - {file = "black-22.12.0-cp37-cp37m-win_amd64.whl", hash = "sha256:1f58cbe16dfe8c12b7434e50ff889fa479072096d79f0a7f25e4ab8e94cd8350"}, - {file = "black-22.12.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:77d86c9f3db9b1bf6761244bc0b3572a546f5fe37917a044e02f3166d5aafa7d"}, - {file = "black-22.12.0-cp38-cp38-win_amd64.whl", hash = "sha256:82d9fe8fee3401e02e79767016b4907820a7dc28d70d137eb397b92ef3cc5bfc"}, - {file = "black-22.12.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:101c69b23df9b44247bd88e1d7e90154336ac4992502d4197bdac35dd7ee3320"}, - {file = "black-22.12.0-cp39-cp39-win_amd64.whl", hash = "sha256:559c7a1ba9a006226f09e4916060982fd27334ae1998e7a38b3f33a37f7a2148"}, - {file = "black-22.12.0-py3-none-any.whl", hash = "sha256:436cc9167dd28040ad90d3b404aec22cedf24a6e4d7de221bec2730ec0c97bcf"}, - {file = "black-22.12.0.tar.gz", hash = "sha256:229351e5a18ca30f447bf724d007f890f97e13af070bb6ad4c0a441cd7596a2f"}, + {file = "black-24.8.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:09cdeb74d494ec023ded657f7092ba518e8cf78fa8386155e4a03fdcc44679e6"}, + {file = "black-24.8.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:81c6742da39f33b08e791da38410f32e27d632260e599df7245cccee2064afeb"}, + {file = "black-24.8.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:707a1ca89221bc8a1a64fb5e15ef39cd755633daa672a9db7498d1c19de66a42"}, + {file = "black-24.8.0-cp310-cp310-win_amd64.whl", hash = "sha256:d6417535d99c37cee4091a2f24eb2b6d5ec42b144d50f1f2e436d9fe1916fe1a"}, + {file = "black-24.8.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:fb6e2c0b86bbd43dee042e48059c9ad7830abd5c94b0bc518c0eeec57c3eddc1"}, + {file = "black-24.8.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:837fd281f1908d0076844bc2b801ad2d369c78c45cf800cad7b61686051041af"}, + {file = "black-24.8.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:62e8730977f0b77998029da7971fa896ceefa2c4c4933fcd593fa599ecbf97a4"}, + {file = "black-24.8.0-cp311-cp311-win_amd64.whl", hash = "sha256:72901b4913cbac8972ad911dc4098d5753704d1f3c56e44ae8dce99eecb0e3af"}, + {file = "black-24.8.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:7c046c1d1eeb7aea9335da62472481d3bbf3fd986e093cffd35f4385c94ae368"}, + {file = "black-24.8.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:649f6d84ccbae73ab767e206772cc2d7a393a001070a4c814a546afd0d423aed"}, + {file = "black-24.8.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:2b59b250fdba5f9a9cd9d0ece6e6d993d91ce877d121d161e4698af3eb9c1018"}, + {file = "black-24.8.0-cp312-cp312-win_amd64.whl", hash = "sha256:6e55d30d44bed36593c3163b9bc63bf58b3b30e4611e4d88a0c3c239930ed5b2"}, + {file = "black-24.8.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:505289f17ceda596658ae81b61ebbe2d9b25aa78067035184ed0a9d855d18afd"}, + {file = "black-24.8.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:b19c9ad992c7883ad84c9b22aaa73562a16b819c1d8db7a1a1a49fb7ec13c7d2"}, + {file = "black-24.8.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1f13f7f386f86f8121d76599114bb8c17b69d962137fc70efe56137727c7047e"}, + {file = "black-24.8.0-cp38-cp38-win_amd64.whl", hash = "sha256:f490dbd59680d809ca31efdae20e634f3fae27fba3ce0ba3208333b713bc3920"}, + {file = "black-24.8.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:eab4dd44ce80dea27dc69db40dab62d4ca96112f87996bca68cd75639aeb2e4c"}, + {file = "black-24.8.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3c4285573d4897a7610054af5a890bde7c65cb466040c5f0c8b732812d7f0e5e"}, + {file = "black-24.8.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9e84e33b37be070ba135176c123ae52a51f82306def9f7d063ee302ecab2cf47"}, + {file = "black-24.8.0-cp39-cp39-win_amd64.whl", hash = "sha256:73bbf84ed136e45d451a260c6b73ed674652f90a2b3211d6a35e78054563a9bb"}, + {file = "black-24.8.0-py3-none-any.whl", hash = "sha256:972085c618ee94f402da1af548a4f218c754ea7e5dc70acb168bfaca4c2542ed"}, + {file = "black-24.8.0.tar.gz", hash = "sha256:2500945420b6784c38b9ee885af039f5e7471ef284ab03fa35ecdde4688cd83f"}, ] [package.dependencies] click = ">=8.0.0" ipython = {version = ">=7.8.0", optional = true, markers = "extra == \"jupyter\""} mypy-extensions = ">=0.4.3" +packaging = ">=22.0" pathspec = ">=0.9.0" platformdirs = ">=2" tokenize-rt = {version = ">=3.2.0", optional = true, markers = "extra == \"jupyter\""} -tomli = {version = ">=1.1.0", markers = "python_full_version < \"3.11.0a7\""} -typing-extensions = {version = ">=3.10.0.0", markers = "python_version < \"3.10\""} +tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} +typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""} [package.extras] colorama = ["colorama (>=0.4.3)"] -d = ["aiohttp (>=3.7.4)"] +d = ["aiohttp (>=3.7.4)", "aiohttp (>=3.7.4,!=3.9.0)"] jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] uvloop = ["uvloop (>=0.15.2)"] @@ -779,21 +815,19 @@ test = ["coverage[toml]", "ddt (>=1.1.1,!=1.4.3)", "mock", "mypy", "pre-commit", [[package]] name = "griffe" -version = "0.25.0" +version = "0.48.0" description = "Signatures for entire Python programs. Extract the structure, the frame, the skeleton of your project, to generate API documentation or find breaking changes in your API." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "griffe-0.25.0-py3-none-any.whl", hash = "sha256:57527250e06c0fac5381c5ccc9695b6c46a3af51928d99364bf2e5fd9aabf37d"}, - {file = "griffe-0.25.0.tar.gz", hash = "sha256:35d412d2235330a05c755f906458c70ee8a4eec85bc3de20f1fd79d0a501dc38"}, + {file = "griffe-0.48.0-py3-none-any.whl", hash = "sha256:f944c6ff7bd31cf76f264adcd6ab8f3d00a2f972ae5cc8db2d7b6dcffeff65a2"}, + {file = "griffe-0.48.0.tar.gz", hash = "sha256:f099461c02f016b6be4af386d5aa92b01fb4efe6c1c2c360dda9a5d0a863bb7f"}, ] [package.dependencies] +backports-strenum = {version = ">=1.3", markers = "python_version < \"3.11\""} colorama = ">=0.4" -[package.extras] -async = ["aiofiles (>=0.7,<1.0)"] - [[package]] name = "h11" version = "0.14.0" @@ -997,13 +1031,13 @@ trio = ["async_generator", "trio"] [[package]] name = "jinja2" -version = "3.0.3" +version = "3.1.4" description = "A very fast and expressive template engine." optional = false -python-versions = ">=3.6" +python-versions = ">=3.7" files = [ - {file = "Jinja2-3.0.3-py3-none-any.whl", hash = "sha256:077ce6014f7b40d03b47d1f1ca4b0fc8328a692bd284016f806ed0eaca390ad8"}, - {file = "Jinja2-3.0.3.tar.gz", hash = "sha256:611bb273cd68f3b993fabdc4064fc858c5b47a973cb5aa7999ec1ba405c87cd7"}, + {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"}, + {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"}, ] [package.dependencies] @@ -1313,31 +1347,34 @@ files = [ [[package]] name = "mkdocs" -version = "1.4.2" +version = "1.6.0" description = "Project documentation with Markdown." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocs-1.4.2-py3-none-any.whl", hash = "sha256:c8856a832c1e56702577023cd64cc5f84948280c1c0fcc6af4cd39006ea6aa8c"}, - {file = "mkdocs-1.4.2.tar.gz", hash = "sha256:8947af423a6d0facf41ea1195b8e1e8c85ad94ac95ae307fe11232e0424b11c5"}, + {file = "mkdocs-1.6.0-py3-none-any.whl", hash = "sha256:1eb5cb7676b7d89323e62b56235010216319217d4af5ddc543a91beb8d125ea7"}, + {file = "mkdocs-1.6.0.tar.gz", hash = "sha256:a73f735824ef83a4f3bcb7a231dcab23f5a838f88b7efc54a0eef5fbdbc3c512"}, ] [package.dependencies] click = ">=7.0" colorama = {version = ">=0.4", markers = "platform_system == \"Windows\""} ghp-import = ">=1.0" -importlib-metadata = {version = ">=4.3", markers = "python_version < \"3.10\""} +importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} jinja2 = ">=2.11.1" -markdown = ">=3.2.1,<3.4" +markdown = ">=3.3.6" +markupsafe = ">=2.0.1" mergedeep = ">=1.3.4" +mkdocs-get-deps = ">=0.2.0" packaging = ">=20.5" +pathspec = ">=0.11.1" pyyaml = ">=5.1" pyyaml-env-tag = ">=0.1" watchdog = ">=2.0" [package.extras] i18n = ["babel (>=2.9.0)"] -min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.3)", "jinja2 (==2.11.1)", "markdown (==3.2.1)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "packaging (==20.5)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "typing-extensions (==3.10)", "watchdog (==2.0)"] +min-versions = ["babel (==2.9.0)", "click (==7.0)", "colorama (==0.4)", "ghp-import (==1.0)", "importlib-metadata (==4.4)", "jinja2 (==2.11.1)", "markdown (==3.3.6)", "markupsafe (==2.0.1)", "mergedeep (==1.3.4)", "mkdocs-get-deps (==0.2.0)", "packaging (==20.5)", "pathspec (==0.11.1)", "pyyaml (==5.1)", "pyyaml-env-tag (==0.1)", "watchdog (==2.0)"] [[package]] name = "mkdocs-autorefs" @@ -1355,25 +1392,51 @@ Markdown = ">=3.3" markupsafe = ">=2.0.1" mkdocs = ">=1.1" +[[package]] +name = "mkdocs-get-deps" +version = "0.2.0" +description = "MkDocs extension that lists all dependencies according to a mkdocs.yml file" +optional = false +python-versions = ">=3.8" +files = [ + {file = "mkdocs_get_deps-0.2.0-py3-none-any.whl", hash = "sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134"}, + {file = "mkdocs_get_deps-0.2.0.tar.gz", hash = "sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c"}, +] + +[package.dependencies] +importlib-metadata = {version = ">=4.3", markers = "python_version < \"3.10\""} +mergedeep = ">=1.3.4" +platformdirs = ">=2.2.0" +pyyaml = ">=5.1" + [[package]] name = "mkdocs-material" -version = "8.5.11" +version = "9.5.31" description = "Documentation that simply works" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocs_material-8.5.11-py3-none-any.whl", hash = "sha256:c907b4b052240a5778074a30a78f31a1f8ff82d7012356dc26898b97559f082e"}, - {file = "mkdocs_material-8.5.11.tar.gz", hash = "sha256:b0ea0513fd8cab323e8a825d6692ea07fa83e917bb5db042e523afecc7064ab7"}, + {file = "mkdocs_material-9.5.31-py3-none-any.whl", hash = "sha256:1b1f49066fdb3824c1e96d6bacd2d4375de4ac74580b47e79ff44c4d835c5fcb"}, + {file = "mkdocs_material-9.5.31.tar.gz", hash = "sha256:31833ec664772669f5856f4f276bf3fdf0e642a445e64491eda459249c3a1ca8"}, ] [package.dependencies] -jinja2 = ">=3.0.2" -markdown = ">=3.2" -mkdocs = ">=1.4.0" -mkdocs-material-extensions = ">=1.1" -pygments = ">=2.12" -pymdown-extensions = ">=9.4" -requests = ">=2.26" +babel = ">=2.10,<3.0" +colorama = ">=0.4,<1.0" +jinja2 = ">=3.0,<4.0" +markdown = ">=3.2,<4.0" +mkdocs = ">=1.6,<2.0" +mkdocs-material-extensions = ">=1.3,<2.0" +paginate = ">=0.5,<1.0" +pygments = ">=2.16,<3.0" +pymdown-extensions = ">=10.2,<11.0" +regex = ">=2022.4" +requests = ">=2.26,<3.0" + +[package.extras] +git = ["mkdocs-git-committers-plugin-2 (>=1.1,<2.0)", "mkdocs-git-revision-date-localized-plugin (>=1.2.4,<2.0)"] +imaging = ["cairosvg (>=2.6,<3.0)", "pillow (>=10.2,<11.0)"] +recommended = ["mkdocs-minify-plugin (>=0.7,<1.0)", "mkdocs-redirects (>=1.2,<2.0)", "mkdocs-rss-plugin (>=1.6,<2.0)"] [[package]] name = "mkdocs-material-extensions" @@ -1388,13 +1451,13 @@ files = [ [[package]] name = "mkdocs-typer" -version = "0.0.2" +version = "0.0.3" description = "An MkDocs extension to generate documentation for Typer command line applications" optional = false python-versions = ">=3.7" files = [ - {file = "mkdocs_typer-0.0.2-py3-none-any.whl", hash = "sha256:24d88407b458403db47a953621a31a29f37e781015925d929e783a4719203991"}, - {file = "mkdocs_typer-0.0.2.tar.gz", hash = "sha256:150e1320a02cff86deea55a173da1d72728a9801742b2deba2926d1a33d36c07"}, + {file = "mkdocs_typer-0.0.3-py3-none-any.whl", hash = "sha256:b2a9a44da590a7100114fde4de9123fedfea692d229379984db20ee3b3f12d7c"}, + {file = "mkdocs_typer-0.0.3.tar.gz", hash = "sha256:4dd37f024190a82aaf0f6c984faafb15167d34eab7e29a6a85e61362423a4eb7"}, ] [package.dependencies] @@ -1403,23 +1466,26 @@ typer = "==0.*" [[package]] name = "mkdocstrings" -version = "0.19.1" +version = "0.25.2" description = "Automatic documentation from sources, for MkDocs." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocstrings-0.19.1-py3-none-any.whl", hash = "sha256:32a38d88f67f65b264184ea71290f9332db750d189dea4200cbbe408d304c261"}, - {file = "mkdocstrings-0.19.1.tar.gz", hash = "sha256:d1037cacb4b522c1e8c164ed5d00d724a82e49dcee0af80db8fb67b384faeef9"}, + {file = "mkdocstrings-0.25.2-py3-none-any.whl", hash = "sha256:9e2cda5e2e12db8bb98d21e3410f3f27f8faab685a24b03b06ba7daa5b92abfc"}, + {file = "mkdocstrings-0.25.2.tar.gz", hash = "sha256:5cf57ad7f61e8be3111a2458b4e49c2029c9cb35525393b179f9c916ca8042dc"}, ] [package.dependencies] +click = ">=7.0" +importlib-metadata = {version = ">=4.6", markers = "python_version < \"3.10\""} Jinja2 = ">=2.11.1" Markdown = ">=3.3" MarkupSafe = ">=1.1" -mkdocs = ">=1.2" +mkdocs = ">=1.4" mkdocs-autorefs = ">=0.3.1" -mkdocstrings-python = {version = ">=0.5.2", optional = true, markers = "extra == \"python\""} +platformdirs = ">=2.2.0" pymdown-extensions = ">=6.3" +typing-extensions = {version = ">=4.1", markers = "python_version < \"3.10\""} [package.extras] crystal = ["mkdocstrings-crystal (>=0.3.4)"] @@ -1428,18 +1494,18 @@ python-legacy = ["mkdocstrings-python-legacy (>=0.2.1)"] [[package]] name = "mkdocstrings-python" -version = "0.8.3" +version = "1.10.7" description = "A Python handler for mkdocstrings." optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mkdocstrings-python-0.8.3.tar.gz", hash = "sha256:9ae473f6dc599339b09eee17e4d2b05d6ac0ec29860f3fc9b7512d940fc61adf"}, - {file = "mkdocstrings_python-0.8.3-py3-none-any.whl", hash = "sha256:4e6e1cd6f37a785de0946ced6eb846eb2f5d891ac1cc2c7b832943d3529087a7"}, + {file = "mkdocstrings_python-1.10.7-py3-none-any.whl", hash = "sha256:8999acb8e2cb6ae5edb844ce1ed6a5fcc14285f85cfd9df374d9a0f0be8a40b6"}, + {file = "mkdocstrings_python-1.10.7.tar.gz", hash = "sha256:bfb5e29acfc69c9177d2b11c18d3127d16e553b8da9bb6d184e428d54795600b"}, ] [package.dependencies] -griffe = ">=0.24" -mkdocstrings = ">=0.19" +griffe = ">=0.48" +mkdocstrings = ">=0.25" [[package]] name = "more-itertools" @@ -1622,6 +1688,16 @@ files = [ {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"}, ] +[[package]] +name = "paginate" +version = "0.5.6" +description = "Divides large result sets into pages for easier browsing" +optional = false +python-versions = "*" +files = [ + {file = "paginate-0.5.6.tar.gz", hash = "sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d"}, +] + [[package]] name = "parso" version = "0.8.4" @@ -2405,6 +2481,94 @@ files = [ attrs = ">=22.2.0" rpds-py = ">=0.7.0" +[[package]] +name = "regex" +version = "2024.7.24" +description = "Alternative regular expression module, to replace re." +optional = false +python-versions = ">=3.8" +files = [ + {file = "regex-2024.7.24-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:228b0d3f567fafa0633aee87f08b9276c7062da9616931382993c03808bb68ce"}, + {file = "regex-2024.7.24-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:3426de3b91d1bc73249042742f45c2148803c111d1175b283270177fdf669024"}, + {file = "regex-2024.7.24-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:f273674b445bcb6e4409bf8d1be67bc4b58e8b46fd0d560055d515b8830063cd"}, + {file = "regex-2024.7.24-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:23acc72f0f4e1a9e6e9843d6328177ae3074b4182167e34119ec7233dfeccf53"}, + {file = "regex-2024.7.24-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:65fd3d2e228cae024c411c5ccdffae4c315271eee4a8b839291f84f796b34eca"}, + {file = "regex-2024.7.24-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c414cbda77dbf13c3bc88b073a1a9f375c7b0cb5e115e15d4b73ec3a2fbc6f59"}, + {file = "regex-2024.7.24-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bf7a89eef64b5455835f5ed30254ec19bf41f7541cd94f266ab7cbd463f00c41"}, + {file = "regex-2024.7.24-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:19c65b00d42804e3fbea9708f0937d157e53429a39b7c61253ff15670ff62cb5"}, + {file = "regex-2024.7.24-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:7a5486ca56c8869070a966321d5ab416ff0f83f30e0e2da1ab48815c8d165d46"}, + {file = "regex-2024.7.24-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:6f51f9556785e5a203713f5efd9c085b4a45aecd2a42573e2b5041881b588d1f"}, + {file = "regex-2024.7.24-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:a4997716674d36a82eab3e86f8fa77080a5d8d96a389a61ea1d0e3a94a582cf7"}, + {file = "regex-2024.7.24-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:c0abb5e4e8ce71a61d9446040c1e86d4e6d23f9097275c5bd49ed978755ff0fe"}, + {file = "regex-2024.7.24-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:18300a1d78cf1290fa583cd8b7cde26ecb73e9f5916690cf9d42de569c89b1ce"}, + {file = "regex-2024.7.24-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:416c0e4f56308f34cdb18c3f59849479dde5b19febdcd6e6fa4d04b6c31c9faa"}, + {file = "regex-2024.7.24-cp310-cp310-win32.whl", hash = "sha256:fb168b5924bef397b5ba13aabd8cf5df7d3d93f10218d7b925e360d436863f66"}, + {file = "regex-2024.7.24-cp310-cp310-win_amd64.whl", hash = "sha256:6b9fc7e9cc983e75e2518496ba1afc524227c163e43d706688a6bb9eca41617e"}, + {file = "regex-2024.7.24-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:382281306e3adaaa7b8b9ebbb3ffb43358a7bbf585fa93821300a418bb975281"}, + {file = "regex-2024.7.24-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4fdd1384619f406ad9037fe6b6eaa3de2749e2e12084abc80169e8e075377d3b"}, + {file = "regex-2024.7.24-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3d974d24edb231446f708c455fd08f94c41c1ff4f04bcf06e5f36df5ef50b95a"}, + {file = "regex-2024.7.24-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a2ec4419a3fe6cf8a4795752596dfe0adb4aea40d3683a132bae9c30b81e8d73"}, + {file = "regex-2024.7.24-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:eb563dd3aea54c797adf513eeec819c4213d7dbfc311874eb4fd28d10f2ff0f2"}, + {file = "regex-2024.7.24-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:45104baae8b9f67569f0f1dca5e1f1ed77a54ae1cd8b0b07aba89272710db61e"}, + {file = "regex-2024.7.24-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:994448ee01864501912abf2bad9203bffc34158e80fe8bfb5b031f4f8e16da51"}, + {file = "regex-2024.7.24-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3fac296f99283ac232d8125be932c5cd7644084a30748fda013028c815ba3364"}, + {file = "regex-2024.7.24-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:7e37e809b9303ec3a179085415cb5f418ecf65ec98cdfe34f6a078b46ef823ee"}, + {file = "regex-2024.7.24-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:01b689e887f612610c869421241e075c02f2e3d1ae93a037cb14f88ab6a8934c"}, + {file = "regex-2024.7.24-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:f6442f0f0ff81775eaa5b05af8a0ffa1dda36e9cf6ec1e0d3d245e8564b684ce"}, + {file = "regex-2024.7.24-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:871e3ab2838fbcb4e0865a6e01233975df3a15e6fce93b6f99d75cacbd9862d1"}, + {file = "regex-2024.7.24-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:c918b7a1e26b4ab40409820ddccc5d49871a82329640f5005f73572d5eaa9b5e"}, + {file = "regex-2024.7.24-cp311-cp311-win32.whl", hash = "sha256:2dfbb8baf8ba2c2b9aa2807f44ed272f0913eeeba002478c4577b8d29cde215c"}, + {file = "regex-2024.7.24-cp311-cp311-win_amd64.whl", hash = "sha256:538d30cd96ed7d1416d3956f94d54e426a8daf7c14527f6e0d6d425fcb4cca52"}, + {file = "regex-2024.7.24-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:fe4ebef608553aff8deb845c7f4f1d0740ff76fa672c011cc0bacb2a00fbde86"}, + {file = "regex-2024.7.24-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:74007a5b25b7a678459f06559504f1eec2f0f17bca218c9d56f6a0a12bfffdad"}, + {file = "regex-2024.7.24-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7df9ea48641da022c2a3c9c641650cd09f0cd15e8908bf931ad538f5ca7919c9"}, + {file = "regex-2024.7.24-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6a1141a1dcc32904c47f6846b040275c6e5de0bf73f17d7a409035d55b76f289"}, + {file = "regex-2024.7.24-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:80c811cfcb5c331237d9bad3bea2c391114588cf4131707e84d9493064d267f9"}, + {file = "regex-2024.7.24-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7214477bf9bd195894cf24005b1e7b496f46833337b5dedb7b2a6e33f66d962c"}, + {file = "regex-2024.7.24-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d55588cba7553f0b6ec33130bc3e114b355570b45785cebdc9daed8c637dd440"}, + {file = "regex-2024.7.24-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:558a57cfc32adcf19d3f791f62b5ff564922942e389e3cfdb538a23d65a6b610"}, + {file = "regex-2024.7.24-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:a512eed9dfd4117110b1881ba9a59b31433caed0c4101b361f768e7bcbaf93c5"}, + {file = "regex-2024.7.24-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:86b17ba823ea76256b1885652e3a141a99a5c4422f4a869189db328321b73799"}, + {file = "regex-2024.7.24-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:5eefee9bfe23f6df09ffb6dfb23809f4d74a78acef004aa904dc7c88b9944b05"}, + {file = "regex-2024.7.24-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:731fcd76bbdbf225e2eb85b7c38da9633ad3073822f5ab32379381e8c3c12e94"}, + {file = "regex-2024.7.24-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:eaef80eac3b4cfbdd6de53c6e108b4c534c21ae055d1dbea2de6b3b8ff3def38"}, + {file = "regex-2024.7.24-cp312-cp312-win32.whl", hash = "sha256:185e029368d6f89f36e526764cf12bf8d6f0e3a2a7737da625a76f594bdfcbfc"}, + {file = "regex-2024.7.24-cp312-cp312-win_amd64.whl", hash = "sha256:2f1baff13cc2521bea83ab2528e7a80cbe0ebb2c6f0bfad15be7da3aed443908"}, + {file = "regex-2024.7.24-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:66b4c0731a5c81921e938dcf1a88e978264e26e6ac4ec96a4d21ae0354581ae0"}, + {file = "regex-2024.7.24-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:88ecc3afd7e776967fa16c80f974cb79399ee8dc6c96423321d6f7d4b881c92b"}, + {file = "regex-2024.7.24-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:64bd50cf16bcc54b274e20235bf8edbb64184a30e1e53873ff8d444e7ac656b2"}, + {file = "regex-2024.7.24-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:eb462f0e346fcf41a901a126b50f8781e9a474d3927930f3490f38a6e73b6950"}, + {file = "regex-2024.7.24-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a82465ebbc9b1c5c50738536fdfa7cab639a261a99b469c9d4c7dcbb2b3f1e57"}, + {file = "regex-2024.7.24-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:68a8f8c046c6466ac61a36b65bb2395c74451df2ffb8458492ef49900efed293"}, + {file = "regex-2024.7.24-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dac8e84fff5d27420f3c1e879ce9929108e873667ec87e0c8eeb413a5311adfe"}, + {file = "regex-2024.7.24-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ba2537ef2163db9e6ccdbeb6f6424282ae4dea43177402152c67ef869cf3978b"}, + {file = "regex-2024.7.24-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:43affe33137fcd679bdae93fb25924979517e011f9dea99163f80b82eadc7e53"}, + {file = "regex-2024.7.24-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:c9bb87fdf2ab2370f21e4d5636e5317775e5d51ff32ebff2cf389f71b9b13750"}, + {file = "regex-2024.7.24-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:945352286a541406f99b2655c973852da7911b3f4264e010218bbc1cc73168f2"}, + {file = "regex-2024.7.24-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:8bc593dcce679206b60a538c302d03c29b18e3d862609317cb560e18b66d10cf"}, + {file = "regex-2024.7.24-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:3f3b6ca8eae6d6c75a6cff525c8530c60e909a71a15e1b731723233331de4169"}, + {file = "regex-2024.7.24-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:c51edc3541e11fbe83f0c4d9412ef6c79f664a3745fab261457e84465ec9d5a8"}, + {file = "regex-2024.7.24-cp38-cp38-win32.whl", hash = "sha256:d0a07763776188b4db4c9c7fb1b8c494049f84659bb387b71c73bbc07f189e96"}, + {file = "regex-2024.7.24-cp38-cp38-win_amd64.whl", hash = "sha256:8fd5afd101dcf86a270d254364e0e8dddedebe6bd1ab9d5f732f274fa00499a5"}, + {file = "regex-2024.7.24-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:0ffe3f9d430cd37d8fa5632ff6fb36d5b24818c5c986893063b4e5bdb84cdf24"}, + {file = "regex-2024.7.24-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:25419b70ba00a16abc90ee5fce061228206173231f004437730b67ac77323f0d"}, + {file = "regex-2024.7.24-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:33e2614a7ce627f0cdf2ad104797d1f68342d967de3695678c0cb84f530709f8"}, + {file = "regex-2024.7.24-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d33a0021893ede5969876052796165bab6006559ab845fd7b515a30abdd990dc"}, + {file = "regex-2024.7.24-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:04ce29e2c5fedf296b1a1b0acc1724ba93a36fb14031f3abfb7abda2806c1535"}, + {file = "regex-2024.7.24-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b16582783f44fbca6fcf46f61347340c787d7530d88b4d590a397a47583f31dd"}, + {file = "regex-2024.7.24-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:836d3cc225b3e8a943d0b02633fb2f28a66e281290302a79df0e1eaa984ff7c1"}, + {file = "regex-2024.7.24-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:438d9f0f4bc64e8dea78274caa5af971ceff0f8771e1a2333620969936ba10be"}, + {file = "regex-2024.7.24-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:973335b1624859cb0e52f96062a28aa18f3a5fc77a96e4a3d6d76e29811a0e6e"}, + {file = "regex-2024.7.24-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:c5e69fd3eb0b409432b537fe3c6f44ac089c458ab6b78dcec14478422879ec5f"}, + {file = "regex-2024.7.24-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:fbf8c2f00904eaf63ff37718eb13acf8e178cb940520e47b2f05027f5bb34ce3"}, + {file = "regex-2024.7.24-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:ae2757ace61bc4061b69af19e4689fa4416e1a04840f33b441034202b5cd02d4"}, + {file = "regex-2024.7.24-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:44fc61b99035fd9b3b9453f1713234e5a7c92a04f3577252b45feefe1b327759"}, + {file = "regex-2024.7.24-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:84c312cdf839e8b579f504afcd7b65f35d60b6285d892b19adea16355e8343c9"}, + {file = "regex-2024.7.24-cp39-cp39-win32.whl", hash = "sha256:ca5b2028c2f7af4e13fb9fc29b28d0ce767c38c7facdf64f6c2cd040413055f1"}, + {file = "regex-2024.7.24-cp39-cp39-win_amd64.whl", hash = "sha256:7c479f5ae937ec9985ecaf42e2e10631551d909f203e31308c12d703922742f9"}, + {file = "regex-2024.7.24.tar.gz", hash = "sha256:9cfd009eed1a46b27c14039ad5bbc5e71b6367c5b2e6d5f5da0ea91600817506"}, +] + [[package]] name = "requests" version = "2.32.3" @@ -3143,4 +3307,4 @@ api = ["anyio", "fastapi", "uvicorn"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "29ffcdcedc7512fef0d6a3de62c80f86e105b7d2d65d6b07c448738abc64b227" +content-hash = "e9b2eddeda51d9b024f25d21d9d06b4333b39cb832f444e31c6242aa4160e791" diff --git a/pyproject.toml b/pyproject.toml index 42d35d57..411d5245 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,24 +71,23 @@ all = [ ] [tool.poetry.group.dev.dependencies] -black = {extras = ["jupyter"], version = "^22.1.0"} +black = {extras = ["jupyter"], version = "^24.8.0"} pylint = "^3.2.6" pytest = "^7.0.1" pre-commit = "^2.17.0" mypy = "^1.0.0" isort = "^5.10.1" -mkdocs = "1.4.2" -griffe = "0.25.0" -Jinja2 = "<3.1.0" # See https://github.com/mkdocs/mkdocs/issues/2794 -mkdocs-material = "^8.2.6" -mkdocstrings = {version = "^0.19.0", extras = ["python"]} -mkdocs-typer = "^0.0.2" +mkdocs = "^1.6.0" +Jinja2 = "^3.1.4" # See https://github.com/mkdocs/mkdocs/issues/2794 +mkdocs-material = "^9.5.31" +mkdocs-typer = "^0.0.3" python-semantic-release = "^7.32.2" # Types for packages. types-requests = "^2.27.10" types-tabulate = "^0.8.5" types-tqdm = "^4.64.1" +mkdocstrings-python = "^1.10.7" [build-system] requires = ["poetry-core>=1.0.0"] diff --git a/tools/swagger-client-generator/README.md b/tools/swagger-client-generator/README.md index 0f46887a..c302ae5c 100644 --- a/tools/swagger-client-generator/README.md +++ b/tools/swagger-client-generator/README.md @@ -34,3 +34,11 @@ podman machine rm podman-machine-default podman machine init -v $HOME:$HOME podman machine start ``` + +## Docker setup + +For using the Docker CLI, make sure to specify the `DOCKER` and `DOCKER_OPTS` parameters when running the script + +```bash +DOCKER=docker DOCKER_OPTS=" " ./tools/swagger-client-generator/generate-client.sh +``` \ No newline at end of file diff --git a/tools/swagger-client-generator/generate-client.sh b/tools/swagger-client-generator/generate-client.sh index c9df160d..1f9a228c 100755 --- a/tools/swagger-client-generator/generate-client.sh +++ b/tools/swagger-client-generator/generate-client.sh @@ -144,11 +144,16 @@ mkdir -p $rootdir/docs/apis/user mkdir -p $rootdir/docs/apis/kg/query mkdir -p $rootdir/docs/apis/kg/create -# cp -R .generated/cps-public/docs/* $rootdir/docs/apis/public -# cp -R .generated/cps-user/docs/* $rootdir/docs/apis/user -cp -R .generated/ds-public-v2/docs/* $rootdir/docs/apis/public_v2 -# cp -R .generated/cps-kg-query/docs/* $rootdir/docs/apis/kg/create -# cp -R .generated/cps-kg-create/docs/* $rootdir/docs/apis/kg/query +# cp -R .generated/cps-public/docs/README.md $rootdir/docs/apis/public/ +# cp -R .generated/cps-public/docs $rootdir/docs/apis/public/ +# cp -R .generated/cps-user/docs/README.md $rootdir/docs/apis/user/ +# cp -R .generated/cps-user/docs $rootdir/docs/apis/user/ +cp -R .generated/ds-public-v2/README.md $rootdir/docs/apis/public_v2/ +cp -R .generated/ds-public-v2/docs $rootdir/docs/apis/public_v2/ +# cp -R .generated/cps-kg-query/docs/README.md $rootdir/docs/apis/kg/create/ +# cp -R .generated/cps-kg-query/docs $rootdir/docs/apis/kg/create/ +# cp -R .generated/cps-kg-create/docs/README.md $rootdir/docs/apis/kg/query/ +# cp -R .generated/cps-kg-create/docs $rootdir/docs/apis/kg/query/ # Delete the staging directory. rm -rf .generated/