migrate project completely to pyproject.toml (#271)

ianardee · web-flow · commit 52f0f46bdd1a · 2024-11-12T16:40:09.000+01:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -29,7 +29,7 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-docs-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-docs-${{ hashFiles('pyproject.toml') }}
         restore-keys: |
           ${{ runner.os }}-docs-
 
diff --git a/.github/workflows/license.yml b/.github/workflows/license.yml
@@ -13,7 +13,7 @@ jobs:
     timeout-minutes: 30
     strategy:
       matrix:
-        python-version: ["3.8"]
+        python-version: ["3.10"]
     steps:
     - uses: actions/checkout@v4
 
@@ -26,16 +26,16 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-lic-${{ hashFiles('**/setup.cfg') }}
+        key: ${{ runner.os }}-lic-${{ hashFiles('**/pyproject.toml') }}
         restore-keys: |
           ${{ runner.os }}-lic-
 
     - name: Install dependencies
       run: |
         python -m pip install pip
-        pip install pylic~=2.2
+        pip install pylic~=3.6.1
         pip install -e .
 
     - name: License check
       run: |
-        pylic check
+        pylic check --allow-extra-safe-licenses
diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -25,15 +25,15 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-dev-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-lint-${{ hashFiles('pyproject.toml') }}
         restore-keys: |
-          ${{ runner.os }}-dev-
+          ${{ runner.os }}-lint-
 
     - name: Install dependencies
       # We install the full dev requirements to make sure everything installs OK
       run: |
         python -m pip install pip
-        pip install -e .[dev]
+        pip install -e .[lint]
 
     - name: Cache pre-commit
       uses: actions/cache@v4
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -29,7 +29,7 @@ jobs:
         uses: actions/cache@v4
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-build-${{ hashFiles('setup.cfg') }}
+          key: ${{ runner.os }}-build-${{ hashFiles('pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-build-
 
diff --git a/.github/workflows/test-code-samples.yml b/.github/workflows/test-code-samples.yml
@@ -33,7 +33,7 @@ jobs:
         uses: actions/cache@v4
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-samples-${{ hashFiles('**/setup.cfg') }}
+          key: ${{ runner.os }}-samples-${{ hashFiles('**/pyproject.toml') }}
           restore-keys: |
             ${{ runner.os }}-samples-
 
diff --git a/.github/workflows/test-integration.yml b/.github/workflows/test-integration.yml
@@ -38,14 +38,14 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-dev-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-test-${{ hashFiles('pyproject.toml') }}
         restore-keys: |
-          ${{ runner.os }}-dev-
+          ${{ runner.os }}-test-
 
     - name: Install dependencies
       run: |
         python -m pip install pip
-        pip install -e .[dev]
+        pip install -e .[test]
     - name: Run Integration Testing
       env:
           MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
diff --git a/.github/workflows/test-regression.yml b/.github/workflows/test-regression.yml
@@ -39,14 +39,14 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-dev-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-test-${{ hashFiles('pyproject.toml') }}
         restore-keys: |
-          ${{ runner.os }}-dev-
+          ${{ runner.os }}-test-
 
     - name: Install dependencies
       run: |
         python -m pip install pip
-        pip install -e .[dev]
+        pip install -e .[test]
     - name: Run Regression Testing
       env:
           MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -37,14 +37,14 @@ jobs:
       uses: actions/cache@v4
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-dev-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-test-${{ hashFiles('setup.cfg') }}
         restore-keys: |
-          ${{ runner.os }}-dev-
+          ${{ runner.os }}-test-
 
     - name: Install dependencies
       run: |
         python -m pip install pip
-        pip install -e .[dev]
+        pip install -e .[test]
 
     - name: Unit testing with pytest
       env:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -21,8 +21,13 @@ repos:
             "--ignore=D10,D212,D203,D401"
         ]
 
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.18.2
+    hooks:
+      - id: gitleaks
+
   - repo: https://github.com/PyCQA/pylint
-    rev: v2.17.7
+    rev: v3.2.7
     hooks:
       - id: pylint
         name: pylint
diff --git a/examples/auto_multi_receipts_extraction_example.py b/examples/auto_multi_receipts_extraction_example.py
@@ -1,5 +1,3 @@
-import os
-
 from mindee import Client, product
 from mindee.extraction.multi_receipts_extractor.multi_receipts_extractor import (
     extract_receipts,
diff --git a/mindee/extraction/common/image_extractor.py b/mindee/extraction/common/image_extractor.py
@@ -5,7 +5,7 @@
 from PIL import Image
 
 from mindee.error import MindeeError
-from mindee.extraction.common import ExtractedImage
+from mindee.extraction.common.extracted_image import ExtractedImage
 from mindee.geometry import Point, get_min_max_x, get_min_max_y
 from mindee.input import BytesInput, LocalInputSource
 
diff --git a/mindee/input/local_response.py b/mindee/input/local_response.py
@@ -58,7 +58,7 @@ def as_dict(self) -> Dict[str, Any]:
 
     @staticmethod
     def _process_secret_key(
-        secret_key: Union[str, bytes, bytearray]
+        secret_key: Union[str, bytes, bytearray],
     ) -> Union[bytes, bytearray]:
         """
         Processes the secret key as a byte array.
diff --git a/mindee/version b/mindee/version
diff --git a/mindee/versions.py b/mindee/versions.py
@@ -1,9 +1,6 @@
-import os
 import sys
 
-dir_path = os.path.dirname(os.path.realpath(__file__))
-with open(os.path.join(dir_path, "version"), "r", encoding="utf-8") as version_file:
-    __version__ = version_file.read().strip()
+__version__ = "4.13.0"
 
 python_version = f"{sys.version_info[0]}.{sys.version_info[1]}"
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,84 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mindee"
+authors = [
+  {name = "Mindee", email = "opensource@mindee.com"},
+]
+dynamic = ["version"]
+description = "Mindee API helper library for Python"
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: OS Independent",
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Libraries",
+  "License :: OSI Approved :: MIT License",
+]
+
+requires-python = ">=3.7"
+
+dependencies = [
+  "pypdfium2>=4.0,<5",
+  "Pillow>=9.5.0",
+  "pytz>=2023.3",
+  "requests~=2.31.0",
+]
+
+[project.urls]
+Homepage = "https://www.mindee.com"
+Documentation = "https://developers.mindee.com/docs/python-sdk"
+Repository = "https://github.com/publicMindee/mindee-api-python"
+Issues = "https://github.com/mindee/mindee-api-python/issues"
+Changelog = "https://github.com/mindee/mindee-api-python/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+lint = [
+  "pylint==3.2.7",
+  "pre-commit~=3.2.2",
+  "types-pytz>=2023.3",
+  "types-requests~=2.31",
+]
+test = [
+  "toml~=0.10.2",
+  "pytest~=7.4",
+  "pytest-cov~=4.1",
+]
+docs = [
+  "sphinx~=5.3",
+  "sphinx_rtd_theme~=1.1",
+  "sphinx-autodoc-typehints~=1.20",
+]
+build = [
+  "setuptools==57.5.0",
+  "build",
+  "twine",
+]
+
+[project.scripts]
+mindee = "mindee.cli:main"
+
+
+[tool.setuptools]
+packages = ["mindee", ]
+
+[tool.setuptools.dynamic]
+version = {attr = "mindee.versions.__version__"}
+
+[tool.setuptools.package-data]
+"mindee" = ["py.typed"]
+
+
 [tool.black]
 line-length = 88
 target-version = [
@@ -26,16 +107,19 @@ warn_unreachable = true
 module = "pypdfium2.*"
 ignore_missing_imports = true
 
+
 [tool.pylic]
 safe_licenses = [
   "Apache Software License",
   "MIT License",
   "Mozilla Public License 2.0 (MPL 2.0)",
   "BSD License",
   "(Apache-2.0 OR BSD-3-Clause) AND LicenseRef-PdfiumThirdParty",
-  "Historical Permission Notice and Disclaimer (HPND)"
+  "Historical Permission Notice and Disclaimer (HPND)",
+  "CMU License (MIT-CMU)",
 ]
 
+
 [tool.pytest.ini_options]
 addopts = "--pyargs --cov mindee --cov-report term:skip-covered --cov-report term-missing -m 'not regression and not integration'"
 python_files = "test*.py"
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/tests/extras/test_extras_integration.py b/tests/extras/test_extras_integration.py
@@ -1,8 +1,6 @@
-import json
-
 import pytest
 
-from mindee import AsyncPredictResponse, Client
+from mindee import Client
 from mindee.product import InternationalIdV2, InvoiceV4
 from tests.product import PRODUCT_DATA_DIR
 
diff --git a/tests/mindee_http/test_error.py b/tests/mindee_http/test_error.py
@@ -10,7 +10,6 @@
     handle_error,
 )
 from mindee.input.sources import PathInput
-from mindee.mindee_http import clean_request_json
 from tests.test_inputs import FILE_TYPES_DIR
 from tests.utils import clear_envvars, dummy_envvars
 
diff --git a/tests/product/custom/test_custom_v1_v2.py b/tests/product/custom/test_custom_v1_v2.py
@@ -2,7 +2,6 @@
 
 import pytest
 
-from mindee.error.mindee_error import MindeeProductError
 from mindee.geometry.quadrilateral import Quadrilateral
 from mindee.parsing.common.document import Document
 from mindee.parsing.common.page import Page
diff --git a/tests/test_cli.py b/tests/test_cli.py
diff --git a/tests/test_pkg_versions.py b/tests/test_pkg_versions.py

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-import os`
`2`		`-`
`3`	`1`	`from mindee import Client, product`
`4`	`2`	`from mindee.extraction.multi_receipts_extractor.multi_receipts_extractor import (`
`5`	`3`	`extract_receipts,`