Migrate to uv

Author: TomBursch

.github/dependabot.yml

@@ -6,7 +6,7 @@ updates:
     schedule:
       interval: "weekly"
 
-  - package-ecosystem: "pip"
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "weekly"

.github/workflows/pytest.yml

@@ -13,20 +13,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.12'
-        cache: 'pip'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -e .[test]
-        pip install -e .[lint]
-    - name: Lint with Ruff
-      run: |
-        ruff check --output-format=github .
-    - name: Test with pytest and coverage
-      run: |
-        pytest --cov=./ --cov-report=term
+      - uses: actions/checkout@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Install dependencies
+        run: uv sync --locked --all-extras
+      - name: Lint with Ruff
+        run: uv run ruff check --output-format=github .
+      - name: Test with pytest and coverage
+        run: uv run pytest --cov=./ --cov-report=term

.github/workflows/python-publish.yml

@@ -20,20 +20,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
-      - uses: actions/setup-python@v5
+      - uses: astral-sh/setup-uv@v5
         with:
-          python-version: "3.x"
+          enable-cache: true
 
       - name: Build release distributions
-        run: |
-          
-          python -m pip install build
-          python -m build
+        run: uv build
 
       - name: Upload distributions
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
         with:
           name: release-dists
           path: dist/
@@ -53,13 +50,13 @@ jobs:
       url: https://pypi.org/p/kitchenowl-python
 
     steps:
+      - uses: astral-sh/setup-uv@v5
+
       - name: Retrieve release distributions
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v8
         with:
           name: release-dists
           path: dist/
 
       - name: Publish release distributions to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          packages-dir: dist/
+        run: uv publish --trusted-publishing always dist/*

pyproject.toml

@@ -5,45 +5,42 @@ readme = "README.md"
 keywords = ["kitchenowl"]
 version = "0.0.2"
 authors = [
-    {name = "Tom Bursch", email = "tom@kitchenowl.org"},
-    {name = "super-qua"},
+    { name = "Tom Bursch", email = "tom@kitchenowl.org" },
+    { name = "super-qua" },
 ]
-license = {file = "LICENSE"}
+license = { file = "LICENSE" }
 classifiers = [
-  "Development Status :: 3 - Alpha",
-  "Programming Language :: Python"
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python",
 ]
-dependencies = [
-    "aiohttp >= 3.11.11"
-]
-requires-python = ">=3.8"
+dependencies = ["aiohttp >= 3.11.11"]
+requires-python = ">=3.12"
 
 [project.optional-dependencies]
 test = [
-    "aioresponses == 0.7.8",
-    "pytest == 8.3.4",
-    "pytest-asyncio == 0.25.3",
-    "pytest-cov == 6.0.0",
-    "syrupy == 4.8.1"
-]
-lint = [
-    "ruff == 0.9.4"
+    "aioresponses >= 0.7.8",
+    "pytest >= 8.3.4",
+    "pytest-asyncio >= 0.25.3",
+    "pytest-cov >= 6.0.0",
+    "syrupy >= 4.8.1",
 ]
+lint = ["ruff >= 0.9.4"]
 
 [project.urls]
 Homepage = "https://kitchenowl.org"
 Repository = "https://github.com/tombursch/kitchenowl-python"
 Issues = "https://github.com/TomBursch/kitchenowl/issues"
 Changelog = "https://github.com/tombursch/kitchenowl-python/blob/main/CHANGELOG.md"
 
+[build-system]
+requires = ["uv_build>=0.11.3,<0.12"]
+build-backend = "uv_build"
 
 [tool.pytest.ini_options]
 minversion = 6.0
 pythonpath = "src"
 asyncio_mode = "auto"
-markers = [
-    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
-]
+markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]
 
 [tool.ruff]
 line-length = 100
@@ -57,87 +54,86 @@ line-ending = "auto"
 [tool.ruff.lint]
 # linter rules copied from https://github.com/home-assistant/core/blob/dev/pyproject.toml
 select = [
-    "A001", # Variable {name} is shadowing a Python builtin
+    "A001",     # Variable {name} is shadowing a Python builtin
     "ASYNC210", # Async functions should not call blocking HTTP methods
     "ASYNC220", # Async functions should not create subprocesses with blocking methods
     "ASYNC221", # Async functions should not run processes with blocking methods
     "ASYNC222", # Async functions should not wait on processes with blocking methods
     "ASYNC230", # Async functions should not open files with blocking methods like open
     "ASYNC251", # Async functions should not call time.sleep
-    "B002", # Python does not support the unary prefix increment
-    "B005", # Using .strip() with multi-character strings is misleading
-    "B007", # Loop control variable {name} not used within loop body
-    "B014", # Exception handler with duplicate exception
-    "B015", # Pointless comparison. Did you mean to assign a value? Otherwise, prepend assert or remove it.
-    "B017", # pytest.raises(BaseException) should be considered evil
-    "B018", # Found useless attribute access. Either assign it to a variable or remove it.
-    "B023", # Function definition does not bind loop variable {name}
-    "B026", # Star-arg unpacking after a keyword argument is strongly discouraged
-    "B032", # Possible unintentional type annotation (using :). Did you mean to assign (using =)?
-    "B904", # Use raise from to specify exception cause
-    "B905", # zip() without an explicit strict= parameter
+    "B002",     # Python does not support the unary prefix increment
+    "B005",     # Using .strip() with multi-character strings is misleading
+    "B007",     # Loop control variable {name} not used within loop body
+    "B014",     # Exception handler with duplicate exception
+    "B015",     # Pointless comparison. Did you mean to assign a value? Otherwise, prepend assert or remove it.
+    "B017",     # pytest.raises(BaseException) should be considered evil
+    "B018",     # Found useless attribute access. Either assign it to a variable or remove it.
+    "B023",     # Function definition does not bind loop variable {name}
+    "B026",     # Star-arg unpacking after a keyword argument is strongly discouraged
+    "B032",     # Possible unintentional type annotation (using :). Did you mean to assign (using =)?
+    "B904",     # Use raise from to specify exception cause
+    "B905",     # zip() without an explicit strict= parameter
     "BLE",
-    "C", # complexity
-    "COM818", # Trailing comma on bare tuple prohibited
-    "D", # docstrings
-    "DTZ003", # Use datetime.now(tz=) instead of datetime.utcnow()
-    "DTZ004", # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
-    "E", # pycodestyle
-    "F", # pyflakes/autoflake
-    "FLY", # flynt
-    "FURB", # refurb
-    "G", # flake8-logging-format
-    "I", # isort
-    "INP", # flake8-no-pep420
-    "ISC", # flake8-implicit-str-concat
-    "ICN001", # import concentions; {name} should be imported as {asname}
-    "LOG", # flake8-logging
-    "N804", # First argument of a class method should be named cls
-    "N805", # First argument of a method should be named self
-    "N815", # Variable {name} in class scope should not be mixedCase
-    "PERF", # Perflint
-    "PGH", # pygrep-hooks
-    "PIE", # flake8-pie
-    "PL", # pylint
-    "PT", # flake8-pytest-style
-    "PYI", # flake8-pyi
-    "RET", # flake8-return
-    "RSE", # flake8-raise
-    "RUF005", # Consider iterable unpacking instead of concatenation
-    "RUF006", # Store a reference to the return value of asyncio.create_task
-    "RUF010", # Use explicit conversion flag
-    "RUF013", # PEP 484 prohibits implicit Optional
-    "RUF017", # Avoid quadratic list summation
-    "RUF018", # Avoid assignment expressions in assert statements
-    "RUF019", # Unnecessary key check before dictionary access
+    "C",        # complexity
+    "COM818",   # Trailing comma on bare tuple prohibited
+    "D",        # docstrings
+    "DTZ003",   # Use datetime.now(tz=) instead of datetime.utcnow()
+    "DTZ004",   # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
+    "E",        # pycodestyle
+    "F",        # pyflakes/autoflake
+    "FLY",      # flynt
+    "FURB",     # refurb
+    "G",        # flake8-logging-format
+    "I",        # isort
+    "INP",      # flake8-no-pep420
+    "ISC",      # flake8-implicit-str-concat
+    "ICN001",   # import concentions; {name} should be imported as {asname}
+    "LOG",      # flake8-logging
+    "N804",     # First argument of a class method should be named cls
+    "N805",     # First argument of a method should be named self
+    "N815",     # Variable {name} in class scope should not be mixedCase
+    "PERF",     # Perflint
+    "PGH",      # pygrep-hooks
+    "PIE",      # flake8-pie
+    "PL",       # pylint
+    "PT",       # flake8-pytest-style
+    "PYI",      # flake8-pyi
+    "RET",      # flake8-return
+    "RSE",      # flake8-raise
+    "RUF005",   # Consider iterable unpacking instead of concatenation
+    "RUF006",   # Store a reference to the return value of asyncio.create_task
+    "RUF010",   # Use explicit conversion flag
+    "RUF013",   # PEP 484 prohibits implicit Optional
+    "RUF017",   # Avoid quadratic list summation
+    "RUF018",   # Avoid assignment expressions in assert statements
+    "RUF019",   # Unnecessary key check before dictionary access
     # "RUF100", # Unused `noqa` directive; temporarily every now and then to clean them up
-    "S102", # Use of exec detected
-    "S103", # bad-file-permissions
-    "S108", # hardcoded-temp-file
-    "S306", # suspicious-mktemp-usage
-    "S307", # suspicious-eval-usage
-    "S313", # suspicious-xmlc-element-tree-usage
-    "S314", # suspicious-xml-element-tree-usage
-    "S315", # suspicious-xml-expat-reader-usage
-    "S316", # suspicious-xml-expat-builder-usage
-    "S317", # suspicious-xml-sax-usage
-    "S318", # suspicious-xml-mini-dom-usage
-    "S319", # suspicious-xml-pull-dom-usage
-    "S320", # suspicious-xmle-tree-usage
-    "S601", # paramiko-call
-    "S602", # subprocess-popen-with-shell-equals-true
-    "S604", # call-with-shell-equals-true
-    "S608", # hardcoded-sql-expression
-    "S609", # unix-command-wildcard-injection
-    "SIM", # flake8-simplify
-    "SLF", # flake8-self
-    "SLOT", # flake8-slots
-    "T100", # Trace found: {name} used
-    "T20", # flake8-print
+    "S102",   # Use of exec detected
+    "S103",   # bad-file-permissions
+    "S108",   # hardcoded-temp-file
+    "S306",   # suspicious-mktemp-usage
+    "S307",   # suspicious-eval-usage
+    "S313",   # suspicious-xmlc-element-tree-usage
+    "S314",   # suspicious-xml-element-tree-usage
+    "S315",   # suspicious-xml-expat-reader-usage
+    "S316",   # suspicious-xml-expat-builder-usage
+    "S317",   # suspicious-xml-sax-usage
+    "S318",   # suspicious-xml-mini-dom-usage
+    "S319",   # suspicious-xml-pull-dom-usage
+    "S601",   # paramiko-call
+    "S602",   # subprocess-popen-with-shell-equals-true
+    "S604",   # call-with-shell-equals-true
+    "S608",   # hardcoded-sql-expression
+    "S609",   # unix-command-wildcard-injection
+    "SIM",    # flake8-simplify
+    "SLF",    # flake8-self
+    "SLOT",   # flake8-slots
+    "T100",   # Trace found: {name} used
+    "T20",    # flake8-print
     "TID251", # Banned imports
-    "TRY", # tryceratops
-    "UP", # pyupgrade
-    "W", # pycodestyle
+    "TRY",    # tryceratops
+    "UP",     # pyupgrade
+    "W",      # pycodestyle
 ]
 
 ignore = [
@@ -155,21 +151,18 @@ ignore = [
     "PLR0915", # Too many statements ({statements} > {max_statements})
     "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
     "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
-    "PT004", # Fixture {fixture} does not return anything, add leading underscore
-    "PT011", # pytest.raises({exception}) is too broad, set the `match` parameter or use a more specific exception
-    "PT018", # Assertion should be broken down into multiple parts
-    "RUF001", # String contains ambiguous unicode character.
-    "RUF002", # Docstring contains ambiguous unicode character.
-    "RUF003", # Comment contains ambiguous unicode character.
-    "RUF015", # Prefer next(...) over single element slice
-    "SIM102", # Use a single if statement instead of nested if statements
-    "SIM103", # Return the condition {condition} directly
-    "SIM108", # Use ternary operator {contents} instead of if-else-block
-    "SIM115", # Use context handler for opening files
-    "TRY003", # Avoid specifying long messages outside the exception class
-    "TRY400", # Use `logging.exception` instead of `logging.error`
-    # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
-    "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
+    "PT011",   # pytest.raises({exception}) is too broad, set the `match` parameter or use a more specific exception
+    "PT018",   # Assertion should be broken down into multiple parts
+    "RUF001",  # String contains ambiguous unicode character.
+    "RUF002",  # Docstring contains ambiguous unicode character.
+    "RUF003",  # Comment contains ambiguous unicode character.
+    "RUF015",  # Prefer next(...) over single element slice
+    "SIM102",  # Use a single if statement instead of nested if statements
+    "SIM103",  # Return the condition {condition} directly
+    "SIM108",  # Use ternary operator {contents} instead of if-else-block
+    "SIM115",  # Use context handler for opening files
+    "TRY003",  # Avoid specifying long messages outside the exception class
+    "TRY400",  # Use `logging.exception` instead of `logging.error`
 
     # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
     "W191",
@@ -188,7 +181,7 @@ ignore = [
 
     # temporarily disabled
     "RET503",
-    "TRY301"
+    "TRY301",
 ]
 
 [tool.ruff.lint.pydocstyle]

src/kitchenowl_python/py.typed

@@ -2,7 +2,7 @@
 
 # TypedDict for now as it allows for changes in the API return values
 
-from typing import List, NotRequired, TypedDict
+from typing import NotRequired, TypedDict
 
 
 class KitchenOwlShoppingListCategory(TypedDict):
@@ -73,21 +73,21 @@ class KitchenOwlHousehold(TypedDict):
     expenses_feature: bool
     id: int
     language: str
-    member: List[KitchenOwlUser]
+    member: list[KitchenOwlUser]
     name: str
     photo: str | None
     planner_feature: bool
     updated_at: int
-    view_ordering: List[str]
+    view_ordering: list[str]
 
 
-class KitchenOwlHouseholdsResponse(List[KitchenOwlHousehold]):
+class KitchenOwlHouseholdsResponse(list[KitchenOwlHousehold]):
     """The households response from KitchenOwl."""
 
 
-class KitchenOwlShoppingListsResponse(List[KitchenOwlShoppingList]):
+class KitchenOwlShoppingListsResponse(list[KitchenOwlShoppingList]):
     """The shopping lists response from KitchenOwl."""
 
 
-class KitchenOwlShoppingListItemsResponse(List[KitchenOwlShoppingListItem]):
+class KitchenOwlShoppingListItemsResponse(list[KitchenOwlShoppingListItem]):
     """The response for shopping list items from KitchenOwl."""