setup new workflow for checks using tox and uv

Islam Alibekov · Islam Alibekov · commit 94cd53cb86fc · 2024-12-14T01:39:43.000+03:00
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -0,0 +1,52 @@
+name: Checks
+
+on: [pull_request]
+
+jobs:
+  test:
+    name: test with ${{ matrix.env }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+
+    strategy:
+      fail-fast: false
+      matrix:
+        env:
+          # - "3.13"
+          - "3.12"
+          # - "3.11"
+          # - "3.10"
+          # - "3.9"
+        os:
+          - ubuntu-latest
+          # - macos-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          # Install a specific version of uv.
+          version: "0.5.8"
+          enable-cache: true
+
+      # - name: Install dependencies
+      #   run: make deps
+
+      # - name: Install tox
+      #   run: uv tool install --python-preference only-managed --python 3.13 tox --with tox-uv --with tox-gh
+
+      - name: Install Python
+        # Python 3.13 was installed above already
+        # if: matrix.env != '3.13'
+        run: uv python install --python-preference only-managed ${{ matrix.env }}
+
+      - name: Install dependencies
+        run: make deps
+
+      - name: Run test suite
+        run: uv run tox
+        env:
+          TOX_GH_MAJOR_MINOR: ${{ matrix.env }}
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -1,28 +1,39 @@
-name: Tests
+# name: Tests
 
-on: [pull_request]
+# on: [pull_request]
 
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    timeout-minutes: 10
+# jobs:
+#   build:
+#     runs-on: ubuntu-latest
+#     timeout-minutes: 10
 
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+#     strategy:
+#       fail-fast: false
+#       matrix:
+#         python-version:
+#           - "3.9"
+#           - "3.10"
+#           - "3.11"
+#           - "3.12"
+#           - "3.13"
 
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v4
+#     steps:
+#       - name: Checkout sources
+#         uses: actions/checkout@v4
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-            python-version: ${{ matrix.python-version }}
+#       - name: Install uv
+#         uses: astral-sh/setup-uv@v4
+#         with:
+#           # Install a specific version of uv.
+#           version: "0.5.8"
 
-      - name: Install dependencies
-        run: make deps
+#       - name: Set up Python
+#         uses: actions/setup-python@v5
+#         with:
+#             python-version: ${{ matrix.python-version }}
 
-      - name: Run checks
-        run: make tox
+#       - name: Install dependencies
+#         run: make deps
+
+#       - name: Run checks
+#         run: make tox
diff --git a/Makefile b/Makefile
@@ -4,31 +4,25 @@
 REPO_ROOT:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 
 deps: ## install deps (library & development)
-	python3 -m pip install --upgrade pip
-	python3 -m pip install -r requirements-dev.txt
-	python3 -m pip install setuptools wheel
-
-deps-genproto: ## install deps (library & development)
-	python3 -m pip install --upgrade pip
-	python3 -m pip install -r requirements-genproto.txt
+	uv sync --all-groups
 
 tox: ## run ALL checks for ALL available python versions
-	python3 -m tox
+	uv run tox
 
 tox-current: ## run ALL checks ONLY for current python version
 	python3 -m tox -e `python3 -c 'import platform; print("py" + "".join(platform.python_version_tuple()[:2]))'`
 
 test: ## run tests ONLY for current python version
-	python3 -m pytest
+	uv run pytest
 
 lint: ## run linters, formatters for current python versions
-	python3 -m flake8 yandexcloud
-	python3 -m pylint yandexcloud
-	python3 -m mypy yandexcloud
+	uv run flake8 yandexcloud
+	uv run pylint yandexcloud
+	uv run mypy yandexcloud
 
 format:
-	python3 -m isort yandexcloud tests examples
-	python3 -m black yandexcloud tests examples
+	uv run isort yandexcloud tests examples
+	uv run black yandexcloud tests examples
 
 test-all-versions: ## run test for multiple python versions using docker
 	# python 3.12 and 3.13 are not provided in image so we skip them
@@ -39,7 +33,7 @@ submodule:  ## update submodules
 
 proto:  ## regenerate code from protobuf
 	rm -rf yandex
-	python3 -m grpc_tools.protoc \
+	uv run -m grpc_tools.protoc \
         --proto_path=cloudapi \
         --proto_path=cloudapi/third_party/googleapis \
         --python_out=. \
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 [license-image]: https://img.shields.io/github/license/yandex-cloud/python-sdk.svg
 [license-url]: https://github.com/yandex-cloud/python-sdk/blob/master/LICENSE
 
-# Yandex.Cloud SDK (Python) 
+# Yandex.Cloud SDK (Python)
 
 Need to automate your infrastructure or use services provided by Yandex.Cloud? We've got you covered.
 
@@ -42,7 +42,7 @@ sdk = yandexcloud.SDK()
 ### Service Account Keys
 
 ```python
-# you can store and read it from JSON file 
+# you can store and read it from JSON file
 sa_key = {
     "id": "...",
     "service_account_id": "...",
@@ -150,18 +150,33 @@ Notice: if both overrides are used for same endpoint, override by client has pri
 ```python
 from yandexcloud import SDK, set_up_yc_api_endpoint
 kz_region_endpoint = "api.yandexcloud.kz"
-# this will make SDK list endpoints from KZ yc installation 
+# this will make SDK list endpoints from KZ yc installation
 sdk = SDK(iam_token="t1.9eu...", endpoint="api.yandexcloud.kz")
 # or you can use global function
 set_up_yc_api_endpoint(kz_region_endpoint)
 ```
 
 ## Contributing
 ### Dependencies
+We use [uv](https://docs.astral.sh/uv) to manage dependencies.
+Install it with official standalone installer:
+`curl -LsSf https://astral.sh/uv/install.sh | sh`
+
+#### Installing dependencies
 Use `make deps` command to install library, its production and development dependencies.
 
+#### Adding new project dependency with uv
+`uv add cryptography`
+
+#### Adding new optional dependency with uv
+add to `dev` extras section
+`uv add pre-commit --group dev`
+
+add to `genproto` extras section
+`uv add grpcio-tools --group genproto`
+
 ### Formatting
-Use `make format` to autoformat code with black tool. 
+Use `make format` to autoformat code with black tool.
 
 ### Tests
 - `make test` to run tests for current python version
@@ -172,8 +187,8 @@ Use `make format` to autoformat code with black tool.
 
 
 ### Maintaining
-If pull request consists of several meaningful commits, that should be preserved, 
-then use "Rebase and merge" option. Otherwise use "Squash and merge". 
+If pull request consists of several meaningful commits, that should be preserved,
+then use "Rebase and merge" option. Otherwise use "Squash and merge".
 
-New release (changelog, tag and pypi upload) will be automatically created 
+New release (changelog, tag and pypi upload) will be automatically created
 on each push to master via Github Actions workflow.
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,26 +35,31 @@ content-type = "text/markdown"
 [project.urls]
 Homepage = "https://github.com/yandex-cloud/python-sdk"
 
-[project.optional-dependencies]
+[dependency-groups]
 dev = [
+    "pre-commit>=4.0.1",
     "python-semantic-release>=v9.8.8",
-    "tox-gh-actions>=3.2.0",
+    "tox-gh>=1.3.1",
     "tox>=4.14.2",
-    "yandexcloud[format,genproto,lint,test]",
-    "pre-commit>=4.0.1",
+    # "yandexcloud[format,genproto,style,test]",
+    "yandexcloud"
 ]
 format = [
     "black>=24.4.2",
     "isort>=5.13.2",
 ]
 genproto = [
-    "grpcio-tools>=1.59.3",
-    "mypy-protobuf>=3.6.0",
+    "grpcio-tools==1.59.3",
+    "mypy-protobuf==3.6.0",
+    "mypy==1.10",
+    "grpc-stubs>=1.53.0.5",
+    "types-requests>=2.32.0.20241016",
+    "types-six>=1.17.0.20241205",
 ]
-lint = [
+style = [
     "flake8>=7.0.0",
-    "mypy>=1.10",
-    "pylint>=3.1.0",
+    "flake8-pyproject>=1.2.3",
+    "pylint==3.1.0",
 ]
 test = [
     "pytest>=8.1.1",
@@ -126,27 +131,57 @@ module = [
 ignore_missing_imports = true
 
 [tool.tox]
-legacy_tox_ini = """
-[gh-actions]
-python =
-    3.9: py39
-    3.10: py310
-    3.11: py311
-    3.12: py312
-    3.13: py313
-
-[tox]
-envlist = py{39,310,311,312,313}
-
-[testenv]
-deps = -rrequirements-dev.txt
-commands =
-    pytest tests
-    flake8 yandexcloud
-    pylint yandexcloud
-    mypy yandexcloud
-    isort --diff yandexcloud setup.py
-    isort --check yandexcloud setup.py
-    black --diff yandexcloud setup.py
-    black --check yandexcloud setup.py
-"""
+env_list = [
+    "py39",
+    "py310",
+    "py311",
+    "py312",
+    "py313"
+]
+
+[tool.tox.env_run_base]
+description = "Run tests under {base_python}"
+dependency_groups = [
+    "test",
+]
+commands = [["pytest"]]
+
+[tool.tox.env.type]
+description = "Check types with mypy"
+skip_install = true
+dependency_groups = [
+    "genproto",
+    "dev"  # without it cannot import yandexcloud dependencies and [import-untyped] is raised
+]
+commands = [["mypy", "yandexcloud"]]  # TODO: add `tests` directory
+
+[tool.tox.env.format]
+description = "Format code with black and isort"
+skip_install = true
+dependency_groups = [
+  "format",
+]
+commands = [
+    ["black", "--check", "--diff", "yandexcloud"],
+    ["isort", "--check", "--diff", "yandexcloud"],
+]
+
+[tool.tox.env.style]
+description = "Check style with flake8 and pylint"
+skip_install = true
+dependency_groups = [
+    "style",
+    "dev"  # without it cannot import yandexcloud dependencies and E0401 is raised
+]
+commands = [
+    ["flake8", "yandexcloud"],
+    ["pylint", "yandexcloud"],
+]
+
+[tool.tox.gh.python]
+# uncomment when upgrade grpcio-tools, current version does not work with 3.13
+# "3.13" = ["3.13", "type", "format", "style"]
+"3.12" = ["3.12", "type", "format", "style"]
+"3.11" = ["3.11"]
+"3.10" = ["3.10"]
+"3.9" = ["3.9"]
diff --git a/uv.lock b/uv.lock
