change: replace custom types with Pydantic 2

.dockerignore

@@ -0,0 +1,11 @@
+venv
+dist
+docs
+docsrc
+.hypothesis
+.mypy_cache
+.pytest_cache
+.tox
+build
+readme_docs
+scripts

.gitignore

@@ -26,6 +26,7 @@ pip-log.txt
 .coverage
 .tox
 nosetests.xml
+.mypy_cache
 
 # Translations
 *.mo
@@ -37,6 +38,7 @@ nosetests.xml
 .noseids
 .pytest*
 *.json
+.hypothesis
 
 codeship.aes
 .env
@@ -55,10 +57,11 @@ examples/readme.py
 docsrc/_build
 docs/.doctrees
 setup_tests.sh
+test.csv
 
 .venv
 .vscode/
 
 .DS_Store
 .ipynb_checkpoints/
-*.ipynb
+*.ipynb

.pre-commit-config.yaml

@@ -1,12 +1,19 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.5.0
     hooks:
     -   id: check-yaml
+        exclude: ^docs
     -   id: end-of-file-fixer
+        exclude: ^docs
     -   id: trailing-whitespace
+        exclude: ^docs
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        name: isort (python)
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.11.0
     hooks:
     -   id: black
-        language_version: python3

AUTHORS

@@ -1,2 +1,2 @@
 Chris Lee <[email protected]>
-Nicolas Kassis<[email protected]>
+Nicolas Kassis<[email protected]>

CHANGES.txt

@@ -1 +1 @@
-Oct 16 2019 v2.0.0: Complete change of IndicoIo API through the Indico IPA platform. For IPA Platform API use only.
+Oct 16 2019 v2.0.0: Complete change of IndicoIo API through the Indico IPA platform. For IPA Platform API use only.

CODEOWNERS

@@ -1 +1 @@
-* @IndicoDataSolutions/pr-be-indicodata-ai
+* @IndicoDataSolutions/pr-be-indicodata-ai

README.md

@@ -105,13 +105,20 @@ You will also need the following env variables set for the Exchange integration
 2. Activate the virtual environment
    `source venv/bin/activate`
 3. Install the client
-   `python3 setup.py install`
-4. Install pytest
-   `pip3 install pytest`
+   `pip3 install --editable .`
+4. Install test deps
+   `pip3 install "pytest<8" "requests-mock>=1.8.0" "pytest-asyncio>0.21"`
 5. Run tests
    `pytest -sv --host <indico_host> tests/`
    _ Only run unit tests `pytest -sv --host <indico_host> tests/unit/`
    _ Only run integration tests `pytest -sv --host <indico_host> tests/integration/`
+6. Check typing
+   ```sh
+   pip3 install "mypy==1.8" typing_extensions pandas-stubs types-requests types-pytz types-openpyxl
+   mypy --config-file=pyproject.toml
+   ```
+
+Alternatively, run all the unit tests via `docker compose run --rm tester`
 
 # Contributing
 

README.rst

@@ -19,4 +19,4 @@ From source:
 .. code:: bash
 
     git clone https://github.com/IndicoDataSolutions/indico-client-python.git
-    python setup.py install
+    python setup.py install

docker-compose.yaml

@@ -4,4 +4,15 @@ services:
   indico-client-build:
     build:
       context: .
-    entrypoint: [ "sleep", "infinity" ]
+    entrypoint: ["sleep", "infinity"]
+
+  tester:
+    build:
+      context: .
+      dockerfile: tox.Dockerfile
+    volumes:
+      - ./:/indico-client
+      - ${INDICO_API_TOKEN_PATH:-$HOME/indico_api_token.txt}:/root/indico_api_token.txt
+    environment:
+      INDICO_HOST: ${INDICO_HOST:-dev-ci.us-east-2.indico-dev.indico.io}
+    command: tox -vvvvp

docsrc/conf.py

@@ -35,7 +35,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
-    "sphinx_markdown_builder"
+    "sphinx_markdown_builder",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

examples/aio_client.py

@@ -4,10 +4,10 @@
 """
 
 import asyncio
+
 from indico import AsyncIndicoClient, IndicoConfig
 from indico.queries import CreateDataset
 
-
 """
 Examples for client creation
 """

examples/classifier_extraction_workflow/component_demo.py

@@ -3,32 +3,31 @@
 
 Note the dataset in this example was built from data/swaps_with_class.csv
 """
+
 from datetime import datetime
 
+from component_links import get_component_link_id
+from config import CLASSIFIER_CLASSES, DATASET_ID, INDICO_CLIENT
+from queries import get_user_ids
+
+from indico import IndicoClient, IndicoConfig
 from indico.queries import (
-    GetDataset,
-    AddModelGroupComponent,
     AddLinkClassificationComponent,
+    AddModelGroupComponent,
     CreateWorkflow,
+    GetDataset,
 )
-from indico.types import NewLabelsetArguments, NewQuestionnaireArguments, ModelTaskType
-
-from config import INDICO_CLIENT, DATASET_ID, CLASSIFIER_CLASSES
-from queries import get_user_ids
-from component_links import get_component_link_id
-
-
-from indico import IndicoClient, IndicoConfig
+from indico.types import ModelTaskType, NewLabelsetArguments, NewQuestionnaireArguments
 
 HOST = "indico.host"
 API_TOKEN_PATH = "/path/to/indico_api_token.txt"
 
 INDICO_CONFIG = IndicoConfig(host=HOST, api_token_path=API_TOKEN_PATH)
 INDICO_CLIENT = IndicoClient(config=INDICO_CONFIG)
-DATASET_ID = <your dataset id>
+DATASET_ID = int("<your dataset id>")
 
 CLASSIFIER_CLASSES = ["class A", "class B"]
-    
+
 timestamp = datetime.now()
 
 dataset = INDICO_CLIENT.call(GetDataset(DATASET_ID))
@@ -50,13 +49,13 @@
     "name": classifier_name,
     "num_labelers_required": 1,
     "task_type": ModelTaskType.CLASSIFICATION,
-    "target_names": CLASSIFIER_CLASSES
+    "target_names": CLASSIFIER_CLASSES,
 }
 questionnaire_args = {
-        "instructions": "Click things",
-        "show_predictions": True,
-        "users": user_ids
-    }
+    "instructions": "Click things",
+    "show_predictions": True,
+    "users": user_ids,
+}
 
 classifier_wf = INDICO_CLIENT.call(
     AddModelGroupComponent(
@@ -82,7 +81,6 @@
         after_component_id=classifier_component.id,
         filtered_classes=filtered_classes,
         labels=None,
-
     )
 )
 
@@ -93,14 +91,14 @@
 class_a_link_id = get_component_link_id(workflow.id, ["class A"])
 class_b_link_id = get_component_link_id(workflow.id, ["class B"])
 
-#create extraction model 1
+# create extraction model 1
 extraction_model_1_name = f"Extraction 1 {timestamp}"
 new_labelset_args = {
     "datacolumn_id": source_col_id,
     "name": extraction_model_1_name,
     "num_labelers_required": 1,
     "task_type": ModelTaskType.ANNOTATION,
-    "target_names": ["extraction class 1"]
+    "target_names": ["extraction class 1"],
 }
 extraction_model_1 = INDICO_CLIENT.call(
     AddModelGroupComponent(
@@ -114,14 +112,14 @@
     )
 )
 
-#create extraction model 2
+# create extraction model 2
 extraction_model_2_name = f"Extraction 2 {timestamp}"
 new_labelset_args = {
     "datacolumn_id": source_col_id,
     "name": extraction_model_2_name,
     "num_labelers_required": 1,
     "task_type": ModelTaskType.ANNOTATION,
-    "target_names": ["extraction class 2"]
+    "target_names": ["extraction class 2"],
 }
 extraction_model_2 = INDICO_CLIENT.call(
     AddModelGroupComponent(

examples/classifier_extraction_workflow/component_links.py

@@ -1,11 +1,10 @@
 from queries import get_component_links
 
+
 def get_component_link_id(workflow_id, class_filter):
     component_links = get_component_links(workflow_id)
     for component_link in component_links:
         link_filter = component_link["filters"]
         if link_filter:
             if class_filter == link_filter["classes"]:
                 return component_link["id"]
-
-

examples/classifier_extraction_workflow/queries.py

@@ -24,18 +24,18 @@ def get_component_links(workflow_id, indico_client):
     workflow_query = """
         query ListWorkflows($workflowIds: [Int]){
             workflows(workflowIds: $workflowIds){
-                workflows {                   
+                workflows {
                     componentLinks{
                         id
                         headComponentId
                         tailComponentId
                         filters{
                             classes
-                        }                        
+                        }
                     }
                 }
             }
-        }            
+        }
     """
     variables = {"workflowIds": [workflow_id]}
     resp = indico_client.call(GraphQLRequest(workflow_query, variables))

examples/create-download-export.py

@@ -1,7 +1,7 @@
-from indico import IndicoClient, IndicoConfig
-from indico.queries import GetDataset, CreateExport, DownloadExport
 import pandas as pd
 
+from indico import IndicoClient, IndicoConfig
+from indico.queries import CreateExport, DownloadExport, GetDataset
 
 """Example 1: Create export from dataset and download as csv"""
 

examples/create-image-dataset.py

@@ -6,9 +6,10 @@
 below shows you what to do if the images are on your computer.
 """
 
+import pandas as pd
+
 from indico import IndicoClient, IndicoConfig
 from indico.queries import CreateDataset
-import pandas as pd
 
 # Create an Indico API client
 my_config = IndicoConfig(

examples/custom_client.py

@@ -1,4 +1,5 @@
 import os
+
 from indico import IndicoClient, IndicoConfig
 
 # Will connect to https://try.indico.io

examples/get-document-report.py

@@ -1,10 +1,10 @@
 from datetime import datetime
 from typing import List
-from indico import IndicoConfig, IndicoClient
+
+from indico import IndicoClient, IndicoConfig
+from indico.filters import DocumentReportFilter
 from indico.queries.document_report import GetDocumentReport
 from indico.types.document_report import DocumentReport
-from indico.filters import DocumentReportFilter
-
 
 """Example 1: Document Report for a date range and page through the results"""
 

examples/get-user-metrics.py

@@ -1,13 +1,13 @@
 from datetime import datetime, timedelta
 
-from indico import IndicoConfig, IndicoClient
-from indico.filters import or_, UserMetricsFilter
+from indico import IndicoClient, IndicoConfig
+from indico.filters import UserMetricsFilter, or_
 from indico.queries import JobStatus, RetrieveStorageObject
 from indico.queries.usermetrics import (
-    GetUserSummary,
-    GetUserSnapshots,
     GenerateChangelogReport,
     GetUserChangelog,
+    GetUserSnapshots,
+    GetUserSummary,
 )
 from indico.types.user_metrics import UserSummary
 

examples/get-workflow-metrics.py

@@ -1,7 +1,9 @@
 from datetime import datetime
 from typing import List
+
 import pandas as pd
-from indico import IndicoConfig, IndicoClient
+
+from indico import IndicoClient, IndicoConfig
 from indico.queries import ListWorkflows
 from indico.queries.workflow_metrics import GetWorkflowMetrics
 from indico.types.workflow_metrics import WorkflowMetrics, WorkflowMetricsOptions

examples/graphql.py

@@ -1,7 +1,6 @@
 from indico import IndicoClient, IndicoConfig
 from indico.queries import GraphQLRequest
 
-
 my_config = IndicoConfig(
     host="try.indico.io", api_token_path="./path/to/indico_api_token.txt"
 )

examples/train-classification-model.py

@@ -1,10 +1,10 @@
 from indico import IndicoClient, IndicoConfig
 from indico.queries import (
-    CreateDataset,
-    ModelGroupPredict,
     AddModelGroupComponent,
-    JobStatus,
+    CreateDataset,
     GetModelGroupSelectedModelStatus,
+    JobStatus,
+    ModelGroupPredict,
 )
 
 # Create an Indico API client