Migrate from pip to uv: faster, safer, reproducible builds

Author: Avasam

.github/workflows/ci.yml

@@ -6,15 +6,15 @@ on:
     branches:
       - master
     paths:
-      - ".github/workflows/type-checking.yml"
+      - ".github/workflows/ci.yml"
       - "docs/**"
       - ".readthedocs.yaml"
       - "pyproject.toml"
       - "setup.cfg"
       - "**/*.py"
   pull_request:
     paths:
-      - ".github/workflows/type-checking.yml"
+      - ".github/workflows/ci.yml"
       - "docs/**"
       - ".readthedocs.yaml"
       - "pyproject.toml"
@@ -30,21 +30,23 @@ jobs:
         python-version: ["3.10"]
       fail-fast: false
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v6
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.2.0
         with:
           python-version: ${{ matrix.python-version }}
-      - run: pip install . --group=dev
+          activate-environment: true
+      - run: uv sync --locked
       - run: mypy . --python-version=${{ matrix.python-version }}
 
   sphinx:
     runs-on: ubuntu-22.04 # Keep in sync with build.os in .readthedocs.yaml
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v6
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v8.2.0
         with:
           python-version: "3.11" # Keep in sync with build.tools.python in .readthedocs.yaml
-      - run: pip install . --group=docs
+          activate-environment: true
+      - run: uv sync --locked --no-default-groups --group=docs
       - name: Build docs
         # TODO: Add --fail-on-warning, but still too many warnings right now
         run: sphinx-build --keep-going -b html docs/source docs/_build/html

.gitignore

@@ -1,5 +1,6 @@
 venv/
 .tox/
+.python-version
 
 *.pyc
 __pycache__/

.readthedocs.yaml

@@ -13,11 +13,6 @@ build:
     # nodejs: "20"
     # rust: "1.70"
     # golang: "1.20"
-  jobs:
-    install:
-      # Since the install step is overridden, pip is no longer updated automatically.
-      - pip install --upgrade pip
-      - pip install . --group=docs
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
@@ -31,3 +26,14 @@ sphinx:
 # formats:
 #   - pdf
 #   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    # https://docs.readthedocs.com/platform/latest/build-customization.html#install-dependencies-with-uv
+    - method: uv
+      command: sync
+      groups:
+        - docs

README.md

@@ -223,17 +223,17 @@ Note not all windows/applications will have a menu accessible by these methods.
 
 ## Install <a name="install"></a>
 
-To install this module on your system, you can use pip: 
+To install this module on your system, you can use pip:
 
-    pip3 install pywinctl
+    python -m pip install pywinctl
 
-or
+or using uv:
 
-    python3 -m pip install pywinctl
+    uv add pywinctl
 
 Alternatively, you can download the wheel file (.whl) available in the [Download page](https://pypi.org/project/PyWinCtl/#files) and run this (don't forget to replace 'x.xx' with proper version number):
 
-    pip install PyWinCtl-x.xx-py3-none-any.whl
+    python -m pip install PyWinCtl-x.xx-py3-none-any.whl
 
 You may want to add `--force-reinstall` option to be sure you are installing the right dependencies version.
 
@@ -249,14 +249,20 @@ In case you have a problem, comments or suggestions, do not hesitate to [open is
 
 If you want to use this code or contribute, you can either:
 
-* Create a fork of the [repository](https://github.com/Kalmat/PyWinCtl), or 
+* Create a fork of the [repository](https://github.com/Kalmat/PyWinCtl), or
 * [Download the repository](https://github.com/Kalmat/PyWinCtl/archive/refs/heads/master.zip), uncompress, and open it on your IDE of choice (e.g. PyCharm)
 
-Be sure you install all dev dependencies by using pip: `pip install -e . --group=dev`
+Be sure you install all dev dependencies by running:
+
+    uv sync
+
+or
+    python -m venv .venv
+    python -m pip install -e . --group=dev
 
 ## Test <a name="test"></a>
 
 To test this module on your own system, cd to "tests" folder and run:
 
-    python3 test_pywinctl.py
+    uv run test_pywinctl.py
 

pyproject.toml

@@ -7,10 +7,10 @@ name = "PyWinCtl"
 dynamic = ["version"]
 description = "Cross-Platform toolkit to get info on and control windows on screen"
 authors = [
-    { name = "Kalmat", email = "palookjones@gmail.com" },
+    { name = "Kalmat", email = "palookjones@gmail.com" }
 ]
 readme = "README.md"
-license = {file = "LICENSE.txt"}
+license = { file = "LICENSE.txt" }
 requires-python = ">=3.9"
 keywords = [
     "activate",
@@ -66,19 +66,27 @@ docs = [
     "myst-parser",
 ]
 dev = [
-    {include-group = "docs"},
+    { include-group = "docs" },
     "ewmhlib",
     "mypy>=0.990,<2",
     "types-python-xlib>=0.32",
     "types-pywin32>=305.0.0.3",
     "types-setuptools>=65.5",
 ]
 
+[tool.uv]
+exclude-newer = "1 week"
+[tool.uv.exclude-newer-package]
+# Kalmat owns these packages
+ewmhlib = false
+pymonctl = false
+pywinbox = false
+
 [project.urls]
 Homepage = "https://github.com/Kalmat/PyWinCtl"
 
 [tool.setuptools.packages.find]
-where = ["src"]  # list of folders that contain the packages (["."] by default)
+where = ["src"] # list of folders that contain the packages (["."] by default)
 
 [tool.setuptools.dynamic]
-version = {attr = "pywinctl.__version__"}  # any module attribute compatible with ast.literal_eval
+version = { attr = "pywinctl.__version__" } # any module attribute compatible with ast.literal_eval