Updates for uv (#283)

* Makefile, uv.lock and updated pyproject

* remove poetry.lock

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* pre-commit with uv actions

* testing with uv action

* install seaborn and matplotlib as dev dependencies

* remove the poetry traces in pyproject.toml

* update creation of book

* testing requires now a checkout before

* formatting of py files in package

* formatting of py files in package

* apply ruff

* dispatch

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: tschm

.github/workflows/book.yml

@@ -1,34 +1,42 @@
 name: "book"
 
 on:
-  push:
-    branches:
-      - main
-
+- push
 
 jobs:
-  test:
+  marimo:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: cvxgrp/.github/actions/coverage@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
+
+      - uses: cvxgrp/.github/actions/uv/marimo@v2.0.6
 
-  pdoc:
+  test:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: cvxgrp/.github/actions/pdoc@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
 
+      - uses: cvxgrp/.github/actions/uv/coverage@v2.0.6
 
   jupyter:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: cvxgrp/.github/actions/jupyter@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
+
+      - uses: cvxgrp/.github/actions/uv/jupyter@v2.0.6
 
   book:
     runs-on: "ubuntu-latest"
-    needs: [test, pdoc, jupyter]
+    needs: [test, jupyter, marimo]
 
     permissions:
       contents: write
 
     steps:
-      - uses: cvxgrp/.github/actions/book@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
+
+      - uses: cvxgrp/.github/actions/book@v2.0.6

.github/workflows/ci.yml

@@ -15,7 +15,10 @@ jobs:
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      - uses: cvxgrp/.github/actions/test@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
+
+      - uses: cvxgrp/.github/actions/uv/test@v2.0.9
         with:
           os: ${{ matrix.os }}
           python-version: ${{ matrix.python-version }}

.github/workflows/pre-commit.yml

@@ -7,13 +7,22 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
+
+      - uses: cvxgrp/.github/actions/uv/coverage@v2.0.9
 
+      - name: Coveralls GitHub Action
+        uses: coverallsapp/github-action@v2
+        with:
+          files: artifacts/tests/coverage/coverage.info
+          format: lcov
+
+  deptry:
+    runs-on: ubuntu-latest
     steps:
-    - uses: cvxgrp/.github/actions/coverage@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
 
-    # uncomment once the repo is public
-    - name: Coveralls GitHub Action
-      uses: coverallsapp/github-action@v2
-      with:
-        files: artifacts/tests/coverage/coverage.info
-        format: lcov
+      - uses: cvxgrp/.github/actions/uv/deptry@v2.0.9

.github/workflows/release.yml

@@ -1,24 +1,50 @@
-name: Upload Python Package
+name: Bump version and publish
 
 on:
-  release:
-    types: [published]
+  workflow_dispatch:
+  workflow_run:
+    workflows: [ "CI" ]
+    types: [ completed ]
 
 jobs:
-  build:
+  tag:
+    permissions:
+      contents: write
+
+    if: >
+      github.event_name == 'workflow_dispatch' ||
+      (github.event.workflow_run.conclusion == 'success' &&
+       github.event.workflow_run.head_branch == 'main')
+
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: cvxgrp/.github/actions/build@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
 
-  deploy:
+      - name: Generate Tag
+        uses: cvxgrp/.github/actions/uv/tag@v2.0.9
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: tag
     runs-on: ubuntu-latest
-    needs: build
     environment: release
 
     permissions:
+      contents: read
       # This permission is required for trusted publishing.
       id-token: write
 
     steps:
-      - uses: cvxgrp/.github/actions/publish@v1.4.0
+      - name: Checkout [${{ github.repository }}]
+        uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -11,12 +11,13 @@ repos:
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix ]
+      # Run the formatter
+      - id: ruff-format
 
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.44.0
     hooks:
-      - id: markdownlint-fix
-        args: [ "--ignore", "book/**/*.md" ]
+      - id: markdownlint
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.19.1
@@ -31,3 +32,14 @@ repos:
 
       - id: check-github-workflows
         args: ["--verbose"]
+
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
+        args: [-ignore, SC]
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject

Makefile

@@ -1,54 +1,47 @@
 .DEFAULT_GOAL := help
 
-SHELL=/bin/bash
+venv:
+	@curl -LsSf https://astral.sh/uv/install.sh | sh
+	@uv venv --python='3.12'
 
-UNAME=$(shell uname -s)
 
 .PHONY: install
-install:  ## Install a virtual environment
-	@poetry install -vv
+install: venv ## Install a virtual environment
+	@uv pip install --upgrade pip
+	@uv sync --all-extras --dev --frozen
+
 
 .PHONY: fmt
-fmt:  ## Run autoformatting and linting
-	@poetry run pip install pre-commit
-	@poetry run pre-commit install
-	@poetry run pre-commit run --all-files
+fmt: venv ## Run autoformatting and linting
+	@uv pip install pre-commit
+	@uv run pre-commit install
+	@uv run pre-commit run --all-files
 
-.PHONY: test
-test: install ## Run tests
-	@poetry run pytest
 
 .PHONY: clean
 clean:  ## Clean up caches and build artifacts
 	@git clean -X -d -f
 
 
-.PHONY: coverage
-coverage: install ## test and coverage
-	@poetry run coverage run --source=cvx/. -m pytest
-	@poetry run coverage report -m
-	@poetry run coverage html
-
-	@if [ ${UNAME} == "Darwin" ]; then \
-		open htmlcov/index.html; \
-	elif [ ${UNAME} == "linux" ]; then \
-		xdg-open htmlcov/index.html 2> /dev/null; \
-	fi
-
-
 .PHONY: help
 help:  ## Display this help screen
 	@echo -e "\033[1mAvailable commands:\033[0m"
 	@grep -E '^[a-z.A-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-18s\033[0m %s\n", $$1, $$2}' | sort
 
 
-.PHONY: jupyter
-jupyter: install ## Run jupyter lab
-	@poetry run pip install jupyterlab
-	@poetry run jupyter lab
+.PHONY: marimo
+marimo: install ## Install Marimo
+	@uv pip install marimo
+	@uv run marimo edit book/marimo
 
 
-.PHONY: marimo
-marimo: install ## Run jupyter lab
-	@poetry run pip install marimo
-	@poetry run marimo edit book/marimo
+.PHONY: test
+test: install  ## Run pytests
+	@uv pip install pytest
+	@uv run pytest tests
+
+
+.PHONY: jupyter
+jupyter: install ## Run jupyter lab
+	@uv pip install jupyterlab
+	@uv run jupyter lab

book/docs/index.md

@@ -0,0 +1 @@
+../../README.md

book/docs/index.md

@@ -25,9 +25,7 @@ def _(__file__):
 @app.cell
 def _(path, pd):
     # Load historic price data of 20 stocks
-    prices = pd.read_csv(
-        path / "data" / "stock_prices.csv", header=0, index_col=0, parse_dates=True
-    )
+    prices = pd.read_csv(path / "data" / "stock_prices.csv", header=0, index_col=0, parse_dates=True)
     return (prices,)
 
 
@@ -52,9 +50,7 @@ def _(from_ewmas, pd, returns):
 
     combinations = from_ewmas(returns, pairs, clip_at=4.2, mean=True)
 
-    weights = pd.DataFrame(
-        {result.time: result.weights for result in combinations.solve(window=10)}
-    ).transpose()
+    weights = pd.DataFrame({result.time: result.weights for result in combinations.solve(window=10)}).transpose()
     weights
     return combinations, pairs, weights