🔖 Version 5.0.0-alpha1

.github/dependabot.yml

@@ -0,0 +1,69 @@
+version: 2
+
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    open-pull-requests-limit: 8
+    commit-message:
+      prefix: "chore(deps)"
+    groups:
+      runtime-dependencies:
+        patterns:
+          - "requests"
+      optional-dependencies:
+        patterns:
+          - "pypdfium2"
+          - "Pillow"
+      test-dependencies:
+        patterns:
+          - "pytest"
+          - "pytest-cov"
+          - "toml"
+      lint-dependencies:
+        patterns:
+          - "pylint"
+          - "pre-commit"
+          - "types-*"
+      docs-dependencies:
+        patterns:
+          - "sphinx"
+          - "sphinx-*"
+      build-dependencies:
+        patterns:
+          - "build"
+          - "twine"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:30"
+      timezone: "Europe/Paris"
+    open-pull-requests-limit: 3
+    commit-message:
+      prefix: "chore(ci)"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+
+  - package-ecosystem: "pre-commit"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "10:00"
+      timezone: "Europe/Paris"
+    open-pull-requests-limit: 3
+    commit-message:
+      prefix: "chore(pre-commit)"
+    groups:
+      pre-commit-hooks:
+        patterns:
+          - "*"

.github/workflows/_publish-docs.yml

@@ -39,8 +39,14 @@ jobs:
         cd ./docs
         make html
 
+    - name: Sphinx make linkcheck
+      run: |
+        cd ./docs
+        make linkcheck
+
     - name: Deploy
       uses: peaceiris/actions-gh-pages@v4
+      if: success()
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./docs/_build/html

.github/workflows/_smoke-test.yml

@@ -21,7 +21,7 @@ jobs:
       max-parallel: 2
       matrix:
         python-version:
-          - "3.8"
+          - "3.10"
           - "3.14"
     runs-on: "ubuntu-22.04"
     steps:
@@ -56,7 +56,7 @@ jobs:
           ./tests/test_v1_code_samples.sh ${{ secrets.MINDEE_ACCOUNT_SE_TESTS }} ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }}
 
       - name: Notify Slack Action on Failure
-        uses: ravsamhq/notify-slack-action@2.3.0
+        uses: ravsamhq/notify-slack-action@2.5.0
         if: ${{ always() && github.ref_name == 'main' }}
         with:
           status: ${{ job.status }}

.github/workflows/_static-analysis.yml

@@ -52,5 +52,7 @@ jobs:
           ${{ runner.os }}-prec-
 
     - name: Run all static analysis
+      env:
+        SKIP: sphinx-html,sphinx-linkcheck
       run: |
         pre-commit run --all-files

.github/workflows/_test-integrations.yml

@@ -17,7 +17,7 @@ jobs:
           - "ubuntu-22.04"
           - "windows-2022"
         python-version:
-          - "3.8"
+          - "3.10"
           - "3.14"
     runs-on: ${{ matrix.os }}
     steps:

.github/workflows/_test-regressions.yml

@@ -17,7 +17,7 @@ jobs:
           - "ubuntu-22.04"
           - "windows-2022"
         python-version:
-          - "3.8"
+          - "3.10"
           - "3.14"
     runs-on: ${{ matrix.os }}
     steps:

.github/workflows/_test-units.yml

@@ -16,8 +16,6 @@ jobs:
           - "ubuntu-22.04"
           - "windows-2022"
         python-version:
-          - "3.8"
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
@@ -38,7 +36,7 @@ jobs:
       uses: actions/cache@v5
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-test-${{ hashFiles('setup.cfg') }}
+        key: ${{ runner.os }}-test-${{ hashFiles('pyproject.toml') }}
         restore-keys: |
           ${{ runner.os }}-test-
 

.gitignore

@@ -137,5 +137,6 @@ dmypy.json
 *.swp
 *-swp
 _test.py
+_test*.py
 _test.json
 local_test

.pre-commit-config.yaml

@@ -6,13 +6,13 @@ repos:
         args: [ --fix, --exit-non-zero-on-fix]
       - id: ruff-format
 
-  - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.30.0
+  - repo: https://github.com/betterleaks/betterleaks
+    rev: v1.3.1
     hooks:
-      - id: gitleaks
+      - id: betterleaks
 
   - repo: https://github.com/PyCQA/pylint
-    rev: v3.3.9
+    rev: v4.0.5
     hooks:
       - id: pylint
         name: pylint
@@ -22,6 +22,11 @@ repos:
         args: [
           "-j2"
         ]
+  - repo: https://github.com/pypa/pip-audit
+    rev: v2.10.0
+    hooks:
+      - id: pip-audit
+        args: ["."]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.18.2
@@ -30,9 +35,22 @@ repos:
         args: []
         exclude: "tests/|examples/|docs/"
         additional_dependencies:
-          - toml
-          - types-pytz
-          - types-requests
+          - httpx
           - types-setuptools
           - importlib-metadata
           - types-Pillow
+  - repo: local
+    hooks:
+      - id: sphinx-html
+        name: Sphinx HTML build
+        entry: make -C docs html
+        language: system
+        pass_filenames: false
+        files: ^docs/.*$|^mindee/.*\.py$
+
+      - id: sphinx-linkcheck
+        name: Sphinx Linkcheck
+        entry: make -C docs linkcheck
+        language: system
+        pass_filenames: false
+        files: ^docs/.*$|^mindee/.*\.py$

.pylintrc

@@ -104,10 +104,6 @@ recursive=no
 # source root.
 source-roots=
 
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no

docs/client_mixin.rst

@@ -0,0 +1,7 @@
+------------
+Client Mixin
+------------
+
+.. autoclass:: mindee.client_mixin
+    :members:
+    :inherited-members:

docs/client_options.rst

@@ -0,0 +1,8 @@
+Client Options
+##############
+
+Polling Options
+===============
+.. autoclass:: mindee.client_options.polling_options.PollingOptions
+    :members:
+    :inherited-members:

docs/conf.py

@@ -73,3 +73,4 @@
 # -- autodoc-typehints -------------------------------------------------------
 
 typehints_defaults = "comma"
+suppress_warnings = ["ref.python"]

docs/extras/code_samples/bank_account_details_v1.txt

@@ -3,13 +3,14 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
+from mindee import PathInput
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
-input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+input_doc = PathInput("/path/to/the/file.ext")
 
 # Load a file from disk and parse it.
 result: PredictResponse = mindee_client.parse(

docs/extras/code_samples/bank_account_details_v2.txt

@@ -3,13 +3,14 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
+from mindee import PathInput
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
-input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+input_doc = PathInput("/path/to/the/file.ext")
 
 # Load a file from disk and parse it.
 result: PredictResponse = mindee_client.parse(

docs/extras/code_samples/bank_check_v1.txt

@@ -3,13 +3,14 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
+from mindee import PathInput
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
-input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+input_doc = PathInput("/path/to/the/file.ext")
 
 # Load a file from disk and parse it.
 result: PredictResponse = mindee_client.parse(

docs/extras/code_samples/barcode_reader_v1.txt

@@ -3,13 +3,14 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
+from mindee import PathInput
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
-input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+input_doc = PathInput("/path/to/the/file.ext")
 
 # Load a file from disk and parse it.
 result: PredictResponse = mindee_client.parse(

docs/extras/code_samples/carte_grise_v1.txt

@@ -3,13 +3,14 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
+from mindee import PathInput
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
-input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+input_doc = PathInput("/path/to/the/file.ext")
 
 # Load a file from disk and parse it.
 result: PredictResponse = mindee_client.parse(

docs/extras/code_samples/cropper_v1.txt

@@ -3,13 +3,14 @@
 # pip install mindee
 #
 
-from mindee import Client, PredictResponse, product
+from mindee.v1 import Client, PredictResponse, product
+from mindee import PathInput
 
 # Init a new client
 mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
-input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
+input_doc = PathInput("/path/to/the/file.ext")
 
 # Load a file from disk and parse it.
 result: PredictResponse = mindee_client.parse(