Merge pull request #98 from Avasam/PEP-735

Migrate dependency management to PEP 735 + Add sphinx build CI check

Author: Kalmat

.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/workflows/type-checking.yml"
+      - "docs/**"
+      - ".readthedocs.yaml"
+      - "pyproject.toml"
+      - "setup.cfg"
+      - "**/*.py"
+  pull_request:
+    paths:
+      - ".github/workflows/type-checking.yml"
+      - "docs/**"
+      - ".readthedocs.yaml"
+      - "pyproject.toml"
+      - "setup.cfg"
+      - "**/*.py"
+
+jobs:
+  mypy:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        python-version: ["3.10"]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install . --group=dev
+      - 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
+        with:
+          python-version: "3.11" # Keep in sync with build.tools.python in .readthedocs.yaml
+      - run: pip install . --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

.github/workflows/type-checking.yml

@@ -6,13 +6,18 @@ version: 2
 
 # Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-22.04 # Keep in sync with runs-on in .github/workflows/docs.yml
   tools:
-    python: "3.11"
+    python: "3.11" # Keep in sync with python-version in .github/workflows/docs.yml
     # You can also specify other tool versions:
     # 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:
@@ -26,10 +31,3 @@ 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:
-    - requirements: requirements.txt

.readthedocs.yaml

@@ -252,7 +252,7 @@ If you want to use this code or contribute, you can either:
 * 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 dependencies described on "requirements.txt" by using pip
+Be sure you install all dev dependencies by using pip: `pip install -e . --group=dev`
 
 ## Test <a name="test"></a>
 

README.md

@@ -61,11 +61,14 @@ dependencies = [
     "typing_extensions>=4.4.0",
 ]
 
-[project.optional-dependencies]
-dev = [
-    "ewmhlib>=0.2",
-    "mypy>=0.990",
+[dependency-groups]
+docs = [
     "myst-parser",
+]
+dev = [
+    {include-group = "docs"},
+    "ewmhlib",
+    "mypy>=0.990,<2",
     "types-python-xlib>=0.32",
     "types-pywin32>=305.0.0.3",
     "types-setuptools>=65.5",
@@ -78,4 +81,4 @@ Homepage = "https://github.com/Kalmat/PyWinCtl"
 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

pyproject.toml

@@ -2,8 +2,9 @@
 description_file = README.md
 
 [mypy]
-python_version = 3.8
+python_version = 3.9
 mypy_path = src/, typings/
+exclude = build
 strict = True
 
 # Leverage type inference for function return type
@@ -16,7 +17,7 @@ disallow_untyped_defs=False
 warn_unused_ignores = False
 
 disable_error_code =
-  # https://github.com/python/mypy/issues/6232 (redifinition with correct type)
+  # https://github.com/python/mypy/issues/6232 (redefinition with correct type)
   attr-defined, assignment,
   # https://github.com/python/mypy/issues/13975 (@property mistaken as Callable)
   comparison-overlap, truthy-function

requirements.txt

@@ -1,7 +1,8 @@
 import io
 import os
 import re
-from setuptools import setup, find_packages
+
+from setuptools import find_packages, setup
 
 scriptFolder = os.path.dirname(os.path.realpath(__file__))
 os.chdir(scriptFolder)
@@ -44,16 +45,6 @@
         "pywinbox>=0.7",
         "pymonctl>=0.92"
     ],
-    extras_require={
-        'dev': [
-            "types-setuptools>=65.5",
-            "mypy>=0.990",
-            "types-pywin32>=305.0.0.3",
-            "types-python-xlib>=0.32",
-            "myst-parser",
-            "ewmhlib>=0.2",
-        ]
-    },
     keywords="gui window control menu title name geometry size position move resize minimize maximize restore "
              + "hide show activate raise lower close screen-size mouse-position",
     classifiers=[