Merge pull request #716 from superannotateai/develop

Develop

Author: nareksa

.gitignore

@@ -13,6 +13,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+
 develop-eggs/
 dist/
 downloads/

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: 'https://github.com/asottile/reorder_python_imports'
-    rev: v2.3.0
+    rev: v3.13.0
     hooks:
       - id: reorder-python-imports
         exclude: src/lib/app/analytics | src/lib/app/converters | src/lib/app/input_converters
@@ -21,7 +21,7 @@ repos:
         name: Style Guide Enforcement (flake8)
         args:
           - '--max-line-length=120'
-          - --ignore=D100,D203,D405,W503,E203,E501,F841,E126,E712,E123,E131,F821,E121,W605
+          - --ignore=D100,D203,D405,W503,E203,E501,F841,E126,E712,E123,E131,F821,E121,W605,E402
   - repo: 'https://github.com/asottile/pyupgrade'
     rev: v2.4.3
     hooks:
@@ -48,6 +48,19 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
         files: \.rst$
+#  - repo: https://github.com/pre-commit/mirrors-mypy
+#    rev: v1.11.2
+#    hooks:
+#      - id: mypy
+#        additional_dependencies: [ types-six ]
+#  - repo: 'https://github.com/PyCQA/pylint'
+#    rev: v2.13.9
+#    hooks:
+#      - id: pylint
+#        name: Python Linter (pylint)
+#        exclude: tests/|src/lib/app/converters/|src/lib/app/analytics/|src/lib/app/input_converters/
+#        args:
+#          - '--disable=R0903,C0111,C0301,W0703,R0914,R0801,R0913,E0401,W0511,C0413,R0902,C0103,W0201,C0209,W1203,W0707,C0415,W0611'
 #  - repo: 'https://github.com/asottile/dead'
 #    rev: v1.3.0
 #    hooks:

.pylintrc

@@ -0,0 +1,2 @@
+[VARIABLES]
+good-names=i,j,k,e,x,y,z,a,b,f,sa

CHANGELOG.rst

@@ -5,6 +5,24 @@ History
 =======
 
 All release highlights of this project will be documented in this file.
+4.4.25 - Sep 30, 2024
+________________________
+
+**Added**
+
+    - ``SAClient.create_project`` method, a new ``workflow`` argument has been added to define the workflow for the project.
+    - ``SAClient.get_project_steps`` method, added instead of ``get_project_workflow`` function.
+    - ``SAClient.set_project_steps`` method, added instead of ``set_project_workflow`` function.
+    - ``SAClient.list_items`` method has been added to search for items using advanced filtering criteria.
+
+
+**Updated**
+
+    - ``SAClient.create_project`` method, removed ``workflows`` argument, use ``set_project_steps`` function instead.
+    - ``SAClient.clone_project`` method, removed ``copy_workflow`` argument, use ``set_project_steps`` function instead.
+    - ``SAClient.get_project_metadata`` method, removed ``include_workflow`` argument, use ``get_project_steps`` function instead.
+    - ``SAClient.get_project_workflow`` method deprecated, use ``get_project_steps`` function instead.
+    - ``SAClient.set_project_workflow`` method deprecated, use ``set_project_steps`` function instead.
 
 4.4.24 - July 2, 2024
 _______________________

docs/source/api_reference/api_item.rst

@@ -5,6 +5,7 @@ Items
 
 .. automethod:: superannotate.SAClient.query
 .. automethod:: superannotate.SAClient.get_item_by_id
+.. automethod:: superannotate.SAClient.list_items
 .. automethod:: superannotate.SAClient.search_items
 .. automethod:: superannotate.SAClient.attach_items
 .. automethod:: superannotate.SAClient.copy_items

docs/source/api_reference/api_metadata.rst

@@ -28,6 +28,21 @@ Project metadata example:
    }
 
 
+----------
+
+Folder metadata
+_________________
+
+Folder metadata example:
+
+.. code-block:: python
+
+   {
+    "name": "Example folder",
+    "status": "NotStarted"
+   }
+
+
 ----------
 
 Setting metadata
@@ -89,45 +104,29 @@ Item metadata example:
 .. code-block:: python
 
   {
-   "name": "example.jpeg",
-   "path": "project/folder_1/meow.jpeg",
-   "url": "https://sa-public-files.s3.../text_file_example_1.jpeg",
-   "annotation_status": "NotStarted",
-   "annotator_name": None,
-   "qa_name": None,
-   "entropy_value": None,
-   "createdAt": "2022-02-15T20:46:44.000Z",
-   "updatedAt": "2022-02-15T20:46:44.000Z"
-    }
-
-----------
-
-
-Image metadata
-_______________
-
-
-Image metadata example:
-
-.. code-block:: python
-
-   {
-      "name": "000000000001.jpg",
-      "annotation_status": "Completed",
-      "prediction_status": "NotStarted",
-      "segmentation_status": "NotStarted",
-      "annotator_id": None,
-      "annotator_name": None,
-      "qa_id": None,
-      "qa_name": None,
-      "entropy_value": None,
-      "approval_status": None,
-      "createdAt": "2020-08-18T07:30:06.000Z",
-      "updatedAt": "2020-08-18T07:30:06.000Z"
-      "is_pinned": 0,
-      "...": "...",
+   "createdAt": "2022-09-14T07:06:53.000Z",
+   "updatedAt": "2022-09-30T13:14:26.000Z",
+   "id": 33027004,
+   "name": "5199856037_03d1929b7b_o.jpg",
+   "path": "New Classes",
+   "url": "None",
+   "assignments": [
+      {
+         "user_role": "Annotator",
+         "user_id": "annotator@example.com"
+      },
+      {
+         "user_role": "QA",
+         "user_id": "qa@example.com"
+      }
+   ],
+   "entropy_value": "None",
+   "custom_metadata": {
+      "study_date": "2021-12-31",
+      "patient_id": "A1234567890",
+      "medical_specialist": "dr.smith@clinic.com",
+   }
    }
-
 
 ----------
 

docs/source/api_reference/api_project.rst

@@ -22,5 +22,7 @@ Projects
 .. automethod:: superannotate.SAClient.add_contributors_to_project
 .. automethod:: superannotate.SAClient.get_project_settings
 .. automethod:: superannotate.SAClient.set_project_default_image_quality_in_editor
+.. automethod:: superannotate.SAClient.set_project_steps
+.. automethod:: superannotate.SAClient.get_project_steps
 .. automethod:: superannotate.SAClient.set_project_workflow
 .. automethod:: superannotate.SAClient.get_project_workflow

docs/source/userguide/quickstart.rst

@@ -85,7 +85,7 @@ Custom config.ini example:
 
     [DEFAULT]
     SA_TOKEN = <token>
-    LOGGING_LEVEL = DEBUG
+    LOGGING_LEVEL = INFO
     LOGGING_PATH = /Users/username/data/superannotate_logs
 
 ----------

pytest.ini

@@ -3,5 +3,4 @@ minversion = 3.7
 log_cli=true
 python_files = test_*.py
 ;pytest_plugins = ['pytest_profiling']
-;addopts = -n auto --dist=loadscope
-
+addopts = -n 2 --dist loadscope

setup.py

@@ -6,13 +6,14 @@
 
 
 def get_version():
-    init = open(
+    with open(
         os.path.join(os.path.dirname(__file__), "src", "superannotate", "__init__.py")
-    ).read()
-    version_re = re.compile(
-        r"""__version__ = ["']((\d+)\.(\d+)\.(\d+)((dev(\d+))?(b(\d+))?))['"]"""
-    )
-    return version_re.search(init).group(1)
+    ) as f:
+        init = f.read()
+        version_re = re.compile(
+            r"""__version__ = ["']((\d+)\.(\d+)\.(\d+)((dev(\d+))?(b(\d+))?))['"]"""
+        )
+        return version_re.search(init).group(1)
 
 
 sdk_version = get_version()
@@ -22,6 +23,8 @@ def get_version():
 with open("requirements.txt") as f:
     requirements.extend(f.read().splitlines())
 
+with open("README.rst") as f:
+    long_description = f.read()
 
 setup(
     name="superannotate",
@@ -38,7 +41,7 @@ def get_version():
     author="SuperAnnotate AI",
     author_email="support@superannotate.com",
     url="https://github.com/superannotateai/superannotate-python-sdk",
-    long_description=open("README.rst").read(),
+    long_description=long_description,
     long_description_content_type="text/x-rst",
     install_requires=requirements,
     setup_requires=["wheel"],