(wip)

Author: liskin

.github/workflows/check.yaml

@@ -45,23 +45,6 @@ jobs:
         uses: astral-sh/setup-uv@v7
         with:
           add-problem-matchers: 'false'
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
-      - name: Persistent Github pip cache
-        uses: actions/cache@v5
-        with:
-          path: ${{ steps.pip-cache.outputs.dir }}
-          key: pip-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml', 'setup.cfg', 'setup.py', 'Makefile') }}
-          restore-keys: |
-            pip-${{ runner.os }}-${{ matrix.python-version }}-
-            pip-${{ runner.os }}-
-      - name: Persistent Github venv cache
-        uses: actions/cache@v5
-        with:
-          path: .venv/
-          key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('pyproject.toml', 'setup.cfg', 'setup.py', 'Makefile') }}
       - name: Install dependencies
         run: make venv
       - name: flake8
@@ -137,7 +120,9 @@ jobs:
         with:
           add-problem-matchers: 'false'
       - name: Install remaining dependencies
-        run: make venv-system-site-packages
+        run: make venv-system-site-packages VENV=.venv-site
+      - name: Set VENV_PYTHON
+        run: echo "VENV_PYTHON=.venv-site/bin/python" >> "$GITHUB_ENV"
       - name: flake8
         uses: liskin/gh-problem-matcher-wrap@v3
         with:

.gitignore

@@ -1,6 +1,7 @@
 *.egg-info/
 *.md.err
 /.*_cache/
+/.venv-site/
 /.venv/
 /build/
 /dist/

CONTRIBUTING.md

@@ -33,8 +33,6 @@ Other common tasks are available in the [Makefile](Makefile):
 -->
 
     $ make help
-    venv-system-site-packages: Setup ./.venv/ (--system-site-packages)
-    venv: Setup ./.venv/
     check: Invoke all checks (lints, tests, readme)
     lint: Invoke lints
     lint-flake8:
@@ -46,11 +44,13 @@ Other common tasks are available in the [Makefile](Makefile):
     readme: Update usage/examples in *.md and fail if it differs from version control
     dist: Build distribution artifacts (sdist, wheel)
     publish: Publish to PyPI
-    ipython: Invoke IPython in venv (not installed by default)
+    ipython: Invoke IPython with the project and its dependencies available
     clean: Clean all gitignored files/directories
     template-update: Re-render cookiecutter template into the template branch
     template-merge: Re-render cookiecutter template and merge into the current branch
     smoke-dist: Smoke test the build artifacts in an isolated venv (i.e. check for unspecified dependencies)
+    venv: Sync uv venv
+    venv-system-site-packages: Setup $(VENV) (--system-site-packages)
     help: Display this help
 <!-- end include tests/readme/make-help.md -->
 

Makefile

@@ -1,26 +1,14 @@
 SHELL := bash
 .SHELLFLAGS := -eu -o pipefail -c
 
-PYTHON = python3
+UV_RUN_SYNC_FLAGS ?= --exact --all-extras
+VENV_PYTHON ?= uv run $(UV_RUN_SYNC_FLAGS) python
 
-VENV = .venv
-VENV_PYTHON = $(VENV)/bin/python
-VENV_DONE = $(VENV)/.done
-VENV_SYSTEM_SITE_PACKAGES = $(VENV)/.venv-system-site-packages
-VENV_USE_SYSTEM_SITE_PACKAGES = $(wildcard $(VENV_SYSTEM_SITE_PACKAGES))
+VENV ?= $(or $(if $(filter 1,$(words $(VENV_PYTHON))),$(patsubst %/bin/,%,$(filter %/bin/,$(dir $(VENV_PYTHON))))),$(error Cannot determine VENV path))
 
 TEMPLATES_DIR = $(HOME)/src
 TEMPLATE = $(eval TEMPLATE := $$(shell realpath --relative-to=. $$(TEMPLATES_DIR)/cookiecutter-python-cli))$(TEMPLATE)
 
-.PHONY: venv-system-site-packages
-## Setup ./.venv/ (--system-site-packages)
-venv-system-site-packages:
-	$(MAKE) VENV_USE_SYSTEM_SITE_PACKAGES=1 venv
-
-.PHONY: venv
-## Setup ./.venv/
-venv: $(VENV_DONE)
-
 .PHONY: check
 ## Invoke all checks (lints, tests, readme)
 check: lint test readme
@@ -33,17 +21,20 @@ LINT_SOURCES = src/ tests/
 
 .PHONY: lint-flake8
 ##
-lint-flake8: $(VENV_DONE)
+lint-flake8:
 	$(VENV_PYTHON) -m flake8 $(LINT_SOURCES)
 
 .PHONY: lint-mypy
 ##
-lint-mypy: $(VENV_DONE)
-	$(VENV_PYTHON) -m mypy --show-column-numbers $(LINT_SOURCES)
+lint-mypy:
+	$(VENV_PYTHON) -m mypy \
+		--python-executable "$$($(VENV_PYTHON) -c 'import sys; print(sys.executable)')" \
+		--show-column-numbers $(LINT_SOURCES)
+# ^ overrides hardcoded python_executable in pyproject.toml (which is there for pylsp)
 
 .PHONY: lint-isort
 ##
-lint-isort: $(VENV_DONE)
+lint-isort:
 	$(VENV_PYTHON) -m isort --check $(LINT_SOURCES)
 
 .PHONY: test
@@ -52,26 +43,26 @@ test: test-pytest test-prysk
 
 .PHONY: test-pytest
 ##
-test-pytest: $(VENV_DONE)
+test-pytest:
 	$(VENV_PYTHON) -m pytest $(PYTEST_FLAGS) tests/
 
 .PHONY: test-prysk
 ##
 test-prysk: PRYSK_INTERACTIVE=$(shell [ -t 0 ] && echo --interactive)
-test-prysk: $(VENV_DONE)
-	PATH="$(CURDIR)/$(VENV)/bin:$$PATH" \
-	XDG_DATA_HOME=/home/user/.local/share \
-	XDG_CONFIG_HOME=/home/user/.config \
-	$(VENV_PYTHON) -m prysk --indent=4 --shell=/bin/bash $(PRYSK_INTERACTIVE) \
+test-prysk:
+	$(if $(filter-out uv,$(firstword $(VENV_PYTHON))), \
+		PATH="$(CURDIR)/$(VENV)/bin:$$PATH" \
+	)$(VENV_PYTHON) -m prysk --indent=4 --shell=/bin/bash $(PRYSK_INTERACTIVE) \
 		$(wildcard tests/*.md tests/*/*.md tests/*/*/*.md)
+# ^ PATH only needed for venv-system-site-packages, uv sets it already
 
 .PHONY: readme
 ## Update usage/examples in *.md and fail if it differs from version control
 readme: $(wildcard *.md)
 	git diff --exit-code $^
 
 .PHONY: $(wildcard *.md)
-$(wildcard *.md) &: $(VENV_DONE) test-prysk
+$(wildcard *.md) &: test-prysk
 	$(VENV_PYTHON) tests/include-preproc.py --comment-start="<!-- " --comment-end=" -->" $(wildcard *.md)
 
 .PHONY: dist
@@ -85,9 +76,11 @@ publish: dist
 	uv publish
 
 .PHONY: ipython
-## Invoke IPython in venv (not installed by default)
-ipython: $(VENV_DONE)
-	$(VENV_PYTHON) -m IPython
+## Invoke IPython with the project and its dependencies available
+ipython:
+	uv run $(UV_RUN_SYNC_FLAGS) \
+		--with ipython \
+		python -m IPython
 
 .PHONY: clean
 ## Clean all gitignored files/directories
@@ -116,20 +109,21 @@ smoke-dist: dist
 			-- python -m "$$package" --help; \
 	done
 
-define VENV_CREATE
-	$(PYTHON) -m venv $(VENV)
-endef
-
-define VENV_CREATE_SYSTEM_SITE_PACKAGES
-	$(PYTHON) -m venv --system-site-packages --without-pip $(VENV)
-	touch $(VENV_SYSTEM_SITE_PACKAGES)
-endef
+.PHONY: venv
+## Sync uv venv
+venv:
+	uv sync $(UV_RUN_SYNC_FLAGS)
 
-$(VENV_DONE): $(MAKEFILE_LIST) pyproject.toml
-	$(if $(VENV_USE_SYSTEM_SITE_PACKAGES),$(VENV_CREATE_SYSTEM_SITE_PACKAGES),$(VENV_CREATE))
-	$(VENV_PYTHON) -m pip install 'pip >= 25.1' # PEP-735 (dependency groups)
+.PHONY: venv-system-site-packages
+## Setup $(VENV) (--system-site-packages)
+venv-system-site-packages: VENV_PYTHON=$(VENV)/bin/python
+venv-system-site-packages: PYTHON=python3
+venv-system-site-packages:
+	uv venv --system-site-packages --seed $(VENV)
 	extras=$$(uvx --from yq -- tomlq -e -r '.project."optional-dependencies" // [] | keys | join(",")' pyproject.toml); \
 	$(VENV_PYTHON) -m pip install --group dev -e ".[ $$extras ]"
-	touch $@
+	@echo
+	@echo "Now use: make VENV_PYTHON=$(VENV_PYTHON)"
+# ^ uv's dependency solver ignores --system-site-packages, so we need to use pip
 
 include _help.mk

README.md

@@ -132,6 +132,10 @@ least once to let strava-offline reuse these downloaded files.
 [strava-bulk-export]: https://support.strava.com/hc/en-us/articles/216918437-Exporting-your-Data-and-Bulk-Export#Bulk
 
 <!-- include tests/readme/help-gpx.md -->
+<!--
+    $ . "$TESTDIR"/../.xdg-user.sh
+-->
+
     $ strava-offline gpx --help
     Usage: strava-offline gpx [OPTIONS]
 
@@ -192,6 +196,10 @@ which is located at `~/.config/strava_offline/config.yaml` by default
 Sample config file can be generated using the `--config-sample` flag:
 
 <!-- include tests/readme/config-sample.md -->
+<!--
+    $ . "$TESTDIR"/../.xdg-user.sh
+-->
+
     $ strava-offline --config-sample
     # Perform full sync instead of incremental
     full: false

tests/.xdg-user.sh

@@ -0,0 +1,5 @@
+#!bash
+# shellcheck disable=2239
+
+export XDG_DATA_HOME=/home/user/.local/share
+export XDG_CONFIG_HOME=/home/user/.config

tests/readme/config-sample.md

@@ -1,3 +1,7 @@
+<!--
+    $ . "$TESTDIR"/../.xdg-user.sh
+-->
+
     $ strava-offline --config-sample
     # Perform full sync instead of incremental
     full: false

tests/readme/help-gpx.md

@@ -1,3 +1,7 @@
+<!--
+    $ . "$TESTDIR"/../.xdg-user.sh
+-->
+
     $ strava-offline gpx --help
     Usage: strava-offline gpx [OPTIONS]
 

tests/readme/help-sqlite.md

@@ -1,3 +1,7 @@
+<!--
+    $ . "$TESTDIR"/../.xdg-user.sh
+-->
+
     $ strava-offline sqlite --help
     Usage: strava-offline sqlite [OPTIONS]
 

tests/readme/make-help.md

@@ -7,8 +7,6 @@
 -->
 
     $ make help
-    venv-system-site-packages: Setup ./.venv/ (--system-site-packages)
-    venv: Setup ./.venv/
     check: Invoke all checks (lints, tests, readme)
     lint: Invoke lints
     lint-flake8:
@@ -20,9 +18,11 @@
     readme: Update usage/examples in *.md and fail if it differs from version control
     dist: Build distribution artifacts (sdist, wheel)
     publish: Publish to PyPI
-    ipython: Invoke IPython in venv (not installed by default)
+    ipython: Invoke IPython with the project and its dependencies available
     clean: Clean all gitignored files/directories
     template-update: Re-render cookiecutter template into the template branch
     template-merge: Re-render cookiecutter template and merge into the current branch
     smoke-dist: Smoke test the build artifacts in an isolated venv (i.e. check for unspecified dependencies)
+    venv: Sync uv venv
+    venv-system-site-packages: Setup $(VENV) (--system-site-packages)
     help: Display this help