Build with uv (#366)

tybulewicz · web-flow · commit 71476874b4c1 · 2025-08-19T12:05:32.000Z
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -20,9 +20,12 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: "3.10"
+          python-version-file: ".python-version"
+      - name: Install uv
+        uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
       - name: Install dependencies
-        run: pip install 'src/.[docs]'
+        run: |
+          uv sync --locked --extra docs
       - name: Install and Generate Doxygen
         uses: mattnotmitt/doxygen-action@b84fe17600245bb5db3d6c247cc274ea98c15a3b # v1.12.0
       - name: Build Docs
diff --git a/.github/workflows/pre_commit.yml b/.github/workflows/pre_commit.yml
@@ -24,15 +24,19 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: "3.10"
+          python-version-file: ".python-version"
       - name: Set up Node.js
         uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: 22
+      - name: Install uv
+        uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
       - name: Install dependencies
-        run: pip install 'src/.[full]'
+        run: |
+          uv sync --locked --all-extras
       - name: Run pre-commit checks
-        run: pre-commit run --all-files
+        run: |
+          uv run pre-commit run --all-files
   Unit-Tests:
     runs-on: ubuntu-22.04
     steps:
@@ -43,11 +47,15 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: "3.10"
+          python-version-file: ".python-version"
+      - name: Install uv
+        uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
       - name: Install dependencies
-        run: pip install 'src/.[tests,ovms]'
+        run: |
+          uv sync --locked --extra tests --extra ovms
       - name: Run python unit tests
-        run: pytest tests/unit
+        run: |
+          uv run pytest tests/unit
   Zizmor-Scan-PR:
     runs-on: ubuntu-latest
     permissions:
@@ -79,5 +87,5 @@ jobs:
           scan-scope: "changed"
           severity-level: "LOW"
           confidence-level: "LOW"
-          config_file: "src/pyproject.toml"
+          config_file: "./pyproject.toml"
           fail-on-findings: true
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -16,27 +16,27 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - name: Set up Python 3.10
+      - name: Set up Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: "3.10"
+          python-version-file: ".python-version"
       - name: Install pypa/build
         run: |
-          python -m pip install --upgrade build
+          uv sync --locked
       - name: Build sdist
         run: |
-          python -m build --sdist src/
+          uv build --sdist
       - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: artifact-sdist
-          path: src/dist/*.tar.gz
+          path: dist/*.tar.gz
       - name: Build wheel
         run: |
-          python -m build --wheel src/
+          uv build --wheel
       - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: artifact-wheel
-          path: src/dist/*.whl
+          path: dist/*.whl
 
   publish_package:
     name: Publish package
diff --git a/.github/workflows/security-scan.yml b/.github/workflows/security-scan.yml
@@ -47,7 +47,7 @@ jobs:
           scan-scope: "all"
           severity-level: "LOW"
           confidence-level: "LOW"
-          config_file: "src/pyproject.toml"
+          config_file: "pyproject.toml"
           fail-on-findings: false # reports only
 
   trivy-scan:
@@ -60,15 +60,6 @@ jobs:
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
           persist-credentials: false
-      - name: Set up Python
-        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
-        with:
-          python-version: "3.10"
-      - name: Install pip-tools
-        run: python -m pip install pip-tools
-
-      - name: Freeze dependencies
-        run: pip-compile --extra=full -o requirements.txt $(pwd)/src/pyproject.toml
 
       - name: Run Trivy scan
         id: trivy
diff --git a/.github/workflows/test_accuracy.yml b/.github/workflows/test_accuracy.yml
@@ -17,22 +17,15 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: "3.12"
-          cache: pip
-      - name: Create and start a virtual environment
-        run: |
-          python -m venv venv
-          source venv/bin/activate
+          python-version-file: ".python-version"
+      - name: Install uv
+        uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
       - name: Install dependencies
         run: |
-          source venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install src/[tests,build] --extra-index-url https://download.pytorch.org/whl/cpu
+          uv sync --locked --extra tests --extra build --extra-index-url https://download.pytorch.org/whl/cpu
       - name: Prepare test data
         run: |
-          source venv/bin/activate
-          python tests/accuracy/prepare_data.py -d data
+          uv run python tests/accuracy/prepare_data.py -d data
       - name: Run Python Test
         run: |
-          source venv/bin/activate
-          pytest -v --data=./data tests/accuracy/test_accuracy.py
+          uv run pytest --data=./data tests/accuracy/test_accuracy.py
diff --git a/.github/workflows/test_precommit.yml b/.github/workflows/test_precommit.yml
@@ -19,25 +19,18 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
-          python-version: "3.10"
-          cache: pip
-      - name: Create and start a virtual environment
-        run: |
-          python -m venv venv
-          source venv/bin/activate
+          python-version-file: ".python-version"
+      - name: Install uv
+        uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
       - name: Install dependencies
         run: |
-          source venv/bin/activate
-          python -m pip install --upgrade pip
-          pip install src/[tests,ovms] --extra-index-url https://download.pytorch.org/whl/cpu
+          uv sync --locked --extra tests --extra ovms --extra-index-url https://download.pytorch.org/whl/cpu
       - name: Prepare test data
         run: |
-          source venv/bin/activate
-          python tests/precommit/prepare_data.py -d data -p tests/precommit/public_scope.json
+          uv run python tests/precommit/prepare_data.py -d data -p tests/precommit/public_scope.json
       - name: Run test
         run: |
-          source venv/bin/activate
-          pytest --data=./data tests/functional
+          uv run pytest --data=./data tests/functional
   serving_api:
     strategy:
       fail-fast: false
@@ -57,12 +50,12 @@ jobs:
       - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: ${{ matrix.python-version }}
-          cache: pip
+      - name: Install uv
+        uses: astral-sh/setup-uv@d9e0f98d3fc6adb07d1e3d37f3043649ddad06a1 # v6.5.0
       - name: serving_api
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install src/[ovms,tests]
-          python tests/precommit/prepare_data.py -d data -p tests/precommit/public_scope.json
-          python -c "from model_api.models import DetectionModel; DetectionModel.create_model('./data/otx_models/detection_model_with_xai_head.xml').save('ovms_models/ssd_mobilenet_v1_fpn_coco/1/ssd_mobilenet_v1_fpn_coco.xml')"
+          uv sync --locked --extra tests --extra ovms
+          uv run python tests/precommit/prepare_data.py -d data -p tests/precommit/public_scope.json
+          uv run python -c "from model_api.models import DetectionModel; DetectionModel.create_model('./data/otx_models/detection_model_with_xai_head.xml').save('ovms_models/ssd_mobilenet_v1_fpn_coco/1/ssd_mobilenet_v1_fpn_coco.xml')"
           docker run -d --rm -v $GITHUB_WORKSPACE/ovms_models/:/models -p 8000:8000 openvino/model_server:latest --model_path /models/ssd_mobilenet_v1_fpn_coco/ --model_name ssd_mobilenet_v1_fpn_coco --rest_port 8000 --log_level DEBUG --target_device CPU
-          python examples/serving_api/run.py data/coco128/images/train2017/000000000009.jpg  # detects 4 objects
+          uv run python examples/serving_api/run.py data/coco128/images/train2017/000000000009.jpg  # detects 4 objects
diff --git a/.gitignore b/.gitignore
@@ -143,3 +143,6 @@ docs/source/_build/
 
 # vs-code
 .vscode/
+
+data/
+ovms_models/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -55,7 +55,7 @@ repos:
         args:
           [
             "-c",
-            "src/pyproject.toml",
+            "pyproject.toml",
             "--severity-level",
             "all",
             "--confidence-level",
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.10
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -35,28 +35,12 @@ Set up your development environment to start contributing. This involves install
 <details>
 <summary>Development Environment Setup Instructions</summary>
 
-1. Create and activate a new python environment:
+1. Create a new python environment and install the development requirements:
 
    ```bash
-   python -m venv .mapi
-   source .mapi/bin/activate
+   uv sync --all-extras
    ```
 
-2. Install the development requirements:
-
-   ```bash
-   pip install -e ./src[full]
-   ```
-
-3. [Build](https://github.com/open-edge-platform/model_api?tab=readme-ov-file#c) C++ binaries
-
-Make sure to address any pre-commit issues before finalizing your pull request.
-Pre-commit checks can be launched by the command:
-
-```bash
-pre-commit run --all-files
-```
-
 </details>
 
 ### Making Changes
@@ -70,12 +54,12 @@ pre-commit run --all-files
 4. **Pass Tests and Quality Checks:** Ensure the test suite passes and that your code meets quality standards by running:
 
    ```bash
-   pre-commit run --all-files
-   pytest tests/unit
-   python tests/precommit/prepare_data.py -d data -p tests/precommit/public_scope.json
-   pytest --data=./data tests/functional
-   python tests/accuracy/prepare_data.py -d data
-   pytest --data=./data tests/functional
+   uv run pre-commit run --all-files
+   uv run pytest tests/unit
+   uv run python tests/precommit/prepare_data.py -d data -p tests/precommit/public_scope.json
+   uv run pytest --data=./data tests/functional
+   uv run python tests/accuracy/prepare_data.py -d data
+   uv run pytest --data=./data tests/accuracy/test_accuracy.py
    ```
 
 5. **Update the Changelog:** For significant changes, add a summary to the [CHANGELOG](CHANGELOG.md).
diff --git a/README.md b/README.md
@@ -32,9 +32,9 @@ Training Extensions embed all the metadata required for inference into model fil
 
 ## Features
 
-- Python and C++ API
+- Python API
 - Synchronous and asynchronous inference
-- Local inference and serving through the rest API (Python only)
+- Local inference and serving through the rest API
 - Model preprocessing embedding for faster inference
 
 ## Installation
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,12 +4,12 @@
 #
 
 [build-system]
-requires = ["setuptools >= 61.0"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
 [project]
 name = "openvino_model_api"
-version = "0.3.0.4"
+version = "0.4.0.0"
 requires-python = ">=3.10"
 authors = [
   {name = "Intel(R) Corporation"},
@@ -59,16 +59,14 @@ docs = [
 build = [
   "nanobind==2.8.0",
 ]
-full = ["openvino_model_api[dependencies, ovms, tests, docs, build]"]
 
 [project.urls]
 Homepage = "https://github.com/open-edge-platform/model_api"
 Documentation = "https://github.com/open-edge-platform/model_api/blob/master/README.md"
 Repository = "https://github.com/open-edge-platform/model_api.git"
 
-[tool.setuptools.packages.find]
-include = ["model_api*"]
-
+[tool.hatch.build.targets.wheel]
+packages = ["src/model_api"]
 
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 # MYPY CONFIGURATION.                                                         #
@@ -219,7 +217,10 @@ exclude = [
     "buck-out",
     "build",
     "dist",
+    "docs",
+    "examples",
     "node_modules",
+    "tests",
     "venv",
 ]
 
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ repos:`
`55`	`55`	`args:`
`56`	`56`	`[`
`57`	`57`	`"-c",`
`58`		`- "src/pyproject.toml",`
	`58`	`+ "pyproject.toml",`
`59`	`59`	`"--severity-level",`
`60`	`60`	`"all",`
`61`	`61`	`"--confidence-level",`