feat: Switch package management from pipenv to uv

mykola-mokhnach · mykola-mokhnach · commit 1a8156afc5de · 2025-08-06T22:10:24.000+02:00
diff --git a/.github/workflows/functional-test.yml b/.github/workflows/functional-test.yml
@@ -71,13 +71,13 @@ jobs:
       with:
         python-version: 3.12
 
-    - run: |
-        # Separate 'run' creates differnet pipenv env. Does them in one run for now.
-        pip install --upgrade pip
-        pip install --upgrade pipenv
-        pipenv lock --clear
-        pipenv install -d --system
-        pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+    - name: Install uv
+      run: make install-uv
+
+    - name: Run Tests
+      run: |
+        uv run pytest ${{ matrix.test_targets.target}} \
+          --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
       env:
         LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
 
@@ -161,12 +161,9 @@ jobs:
         api-level: ${{ env.API_LEVEL }}
         arch: ${{ env.ARCH }}
         script: |
-          # Separate 'run' creates differnet pipenv env. Does them in one run for now.
-          pip install --upgrade pip
-          pip install --upgrade pipenv
-          pipenv lock --clear
-          pipenv install -d --system
-          pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+          make install-uv
+          uv run pytest ${{ matrix.test_targets.target}} --doctest-modules --junitxml=junit/test-results.xml \
+            --cov=com --cov-report=xml --cov-report=html
         target: google_apis
         profile: Nexus 5X
         disable-spellchecker: true
@@ -251,12 +248,9 @@ jobs:
       with:
         api-level: ${{ env.API_LEVEL }}
         script: |
-          pip install --upgrade pip
-          pip install --upgrade pipenv
-          pipenv lock --clear
-          pipenv install -d --system
-          export PLATFORM=android
-          pytest test/functional/flutter_integration/*_test.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+          make install-uv
+          uv run pytest test/functional/flutter_integration/*_test.py \
+            --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
         target: default
         disable-spellchecker: true
         disable-animations: true
@@ -296,10 +290,7 @@ jobs:
     - name: Run IOS tests
       if: matrix.e2e-tests == 'flutter-ios'
       run: |
-        # Separate 'run' creates differnet pipenv env. Does them in one run for now.
-        pip install --upgrade pip
-        pip install --upgrade pipenv
-        pipenv lock --clear
-        pipenv install -d --system
+        make install-uv
         export PLATFORM=ios
-        pytest test/functional/flutter_integration/*_test.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+        uv run pytest test/functional/flutter_integration/*_test.py \
+          --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
diff --git a/.github/workflows/unit-test.yml b/.github/workflows/unit-test.yml
@@ -19,10 +19,10 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install tox
-      run: pip install tox
+    - name: Install uv
+      run: make install-uv
     - name: Run Tox
-      run: tox -e py
+      run: uv run tox -e py
 
   # test-win:
   #   runs-on: windows-latest
diff --git a/.gitignore b/.gitignore
@@ -24,8 +24,7 @@ __pycache__
 
 # Virtual Environments
 venv*
+.venv
 .tox
 
-Pipfile.lock
-
 .coverage
diff --git a/Makefile b/Makefile
@@ -10,27 +10,42 @@ check: check-lint check-format
 
 .PHONY: check-lint
 check-lint:
-	python -m ruff check .
+	uv run ruff check .
 
 .PHONY: check-format
 check-format:
-	python -m ruff format --check .
+	uv run ruff format --check .
 
 .PHONY: fix
 fix: fix-lint fix-format
 
 .PHONY: fix-lint
 fix-lint:
-	python -m ruff check --fix .
+	uv run ruff check --fix .
 
 .PHONY: fix-format
 fix-format:
-	python -m ruff format .
-
+	uv run ruff format .
+
+.PHONY: install-uv
+install-uv:
+	@command -v uv >/dev/null 2>&1 || { \
+		echo "Installing uv"; \
+		curl -LsSf https://astral.sh/uv/install.sh | sh; \
+		if [ -n "$$GITHUB_PATH" ]; then \
+			echo "PATH=$$HOME/.local/bin:$$PATH" >> $$GITHUB_PATH; \
+		else \
+			echo "Please restart your shell or run 'exec $$SHELL'"; \
+		fi; \
+	}
+
+.PHONY: sync-dev
+sync-dev:
+	uv sync
 
 .PHONY: unittest
 unittest: ## Run unittest
-	python -m pytest $(ARGS) test/unit/
+	uv run pytest $(ARGS) test/unit/
 
 .PHONY: help
 help: ## Display this help screen
diff --git a/Pipfile b/Pipfile
diff --git a/README.md b/README.md
@@ -56,8 +56,8 @@ the Selenium Python binding update might affect the Appium Python Client behavio
 For example, some changes in the Selenium binding could break the Appium client.
 
 > **Note**
-> We strongly recommend you manage dependencies with version management tools such as Pipenv and requirements.txt
-> to keep compatible version combinations.
+> We strongly recommend you manage dependencies with version management tools such as 
+> [uv](https://docs.astral.sh/uv/) to keep compatible version combinations.
 
 
 ### Quick migration guide from v4 to v5
@@ -448,48 +448,47 @@ You have two methods to extend the read timeout.
 
 ### Setup
 
-- `pip install --user pipenv`
-- `python -m pipenv lock --clear`
-  - If you experience `Locking Failed! unknown locale: UTF-8` error, then refer [pypa/pipenv#187](https://github.com/pypa/pipenv/issues/187) to solve it.
-- `python -m pipenv install --dev --system`
-- `pre-commit install`
+```bash
+make install-uv
+exec $SHELL 
+make sync-dev
+```
 
 ### Run tests
 
 You can run all of the tests running on CI via `tox` in your local.
 
 ```bash
-$ tox
+$ uv run tox
 ```
 
 You also can run particular tests like below.
 
 #### Unit
 
 ```bash
-$ pytest test/unit
+$ uv run pytest test/unit
 ```
 
 Run with `pytest-xdist`
 
 ```bash
-$ pytest -n 2 test/unit
+$ uv run pytest -n 2 test/unit
 ```
 
 #### Functional
 
 ```bash
-$ pytest test/functional/ios/search_context/find_by_ios_class_chain_tests.py
+$ uv run pytest test/functional/ios/search_context/find_by_ios_class_chain_tests.py
 ```
 
 #### In parallel for iOS
 
 1. Create simulators named 'iPhone X - 8100' and 'iPhone X - 8101'
-2. Install test libraries via pip, `pip install pytest pytest-xdist`
-3. Run tests
+1. Run tests
 
 ```bash
-$ pytest -n 2 test/functional/ios/search_context/find_by_ios_class_chain_tests.py
+$ uv run pytest -n 2 test/functional/ios/search_context/find_by_ios_class_chain_tests.py
 ```
 
 ## Release
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,34 @@
+[project]
+name = "Appium-Python-Client"
+dynamic = ["version"]
+requires-python = ">=3.9"
+dependencies = [
+  "selenium==4.33.0",
+  "typing-extensions~=4.13.2",
+]
+
+[tool.uv]
+dev-dependencies = [
+  "httpretty~=1.1",
+  "mock~=5.2",
+  "pre-commit~=4.2",
+  "pytest~=8.4",
+  "pytest-cov~=6.2",
+  "pytest-xdist~=3.8",
+  "python-dateutil~=2.9",
+  "ruff~=0.12.7",
+  "tox~=4.27",
+  "types-python-dateutil~=2.9",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "regex"
+path = "appium/version.py"
+pattern = "(?P<version>\\d+\\.\\d+\\.\\d+)"
+
+[tool.hatch.build.targets.wheel]
+packages = ["appium"]
diff --git a/uv.lock b/uv.lock
