Upgrade to uv template.

Author: jlevy

.copier-answers.yml

@@ -1,9 +1,9 @@
 # Changes here will be overwritten by Copier. Do not edit manually.
-_commit: 77a7151
+_commit: 98316a7
 _src_path: gh:jlevy/simple-modern-uv
 package_author_email: [email protected]
 package_author_name: Joshua Levy
 package_description: Simple, useful decorators for logging and tallying function calls
 package_github_org: jlevy
+package_module: funlog
 package_name: funlog
-package_slug: funlog

.github/workflows/ci.yml

@@ -16,53 +16,48 @@ permissions:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         # Update this as needed:
-        python-version: ["3.10","3.11", "3.12", "3.13"]
+
+        # Common platforms: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        os: ["ubuntu-latest"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    # Linux only by default. Use ${{ matrix.os }} for other OSes.
+    runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v4
+      # Generally following uv docs:
+      # https://docs.astral.sh/uv/guides/integration/github/
+
+      - name: Checkout (official GitHub action)
+        uses: actions/checkout@v4
         with:
           # Important for versioning plugins:
           fetch-depth: 0
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: Install uv (official Astral action)
+        uses: astral-sh/setup-uv@v5
         with:
+          version: "0.6.5"
+          enable-cache: true
           python-version: ${{ matrix.python-version }}
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1     
-        with:
-          # Update this as needed:
-          version: 2.1.1
-
-      - name: Configure Poetry to use Python version
-        run: |
-          poetry env use ${{ matrix.python-version }}
-          poetry run python --version
-
-      - name: Cache Poetry dependencies
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cache/pypoetry
-            ~/.cache/pip
-          key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}-${{ matrix.python-version }}
-          restore-keys: |
-            ${{ runner.os }}-poetry-
+      - name: Set up Python (using uv)
+        run: uv python install
 
-      - name: Install Poetry plugins
-        run: |
-          poetry self add "poetry-dynamic-versioning[plugin]"
+      # Alternately can use the official Python action:
+      # - name: Set up Python (using actions/setup-python)
+      #   uses: actions/setup-python@v5
+      #   with:
+      #     python-version: ${{ matrix.python-version }}
 
-      - name: Install dependencies
-        run: poetry install
+      - name: Install all dependencies
+        run: uv sync --all-extras --dev
 
       - name: Run linting
-        run: poetry run python devtools/lint.py
+        run: uv run python devtools/lint.py
 
       - name: Run tests
-        run: poetry run pytest
+        run: uv run pytest

.github/workflows/publish.yml

@@ -12,31 +12,30 @@ jobs:
       id-token: write # Mandatory for OIDC.
       contents: read
     steps:
-      - name: Check out the code
+      - name: Checkout (official GitHub action)
         uses: actions/checkout@v4
         with:
           # Important for versioning plugins:
           fetch-depth: 0
 
-      - name: Set up Python
-        uses: actions/setup-python@v5
+      - name: Install uv (official Astral action)
+        uses: astral-sh/setup-uv@v5
         with:
+          version: "0.6.5"
+          enable-cache: true
           python-version: "3.12"
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          version: latest
-
-      - name: Install Poetry plugins
-        run: |
-          poetry self add "poetry-dynamic-versioning[plugin]"
+      - name: Set up Python (using uv)
+        run: uv python install
 
-      - name: Install dependencies
-        run: poetry install --no-root
+      - name: Install all dependencies
+        run: uv sync --all-extras --dev
 
+      - name: Run tests
+        run: uv run pytest
+        
       - name: Build package
-        run: poetry build
+        run: uv build
 
-      - name: Publish to PyPI
+      - name: Publish to PyPI (using uv)
         uses: pypa/gh-action-pypi-publish@release/v1

Makefile

@@ -1,20 +1,26 @@
+# Makefile for easy development workflows.
+# GitHub Actions call uv directly.
+
 .DEFAULT_GOAL := default
 
-.PHONY: default install_deps lint test build clean
+.PHONY: default install lint test upgrade build clean
 
-default: install_deps lint test
+default: install lint test
 
-install_deps:
-	poetry install
+install:
+	uv sync --all-extras --dev
 
 lint:
-	poetry run python devtools/lint.py
+	uv run python devtools/lint.py
 
 test:
-	poetry run pytest
+	uv run pytest
+
+upgrade:
+	uv sync --upgrade
 
 build:
-	poetry build
+	uv build
 
 clean:
 	-rm -rf dist/

README.md

@@ -1,5 +1,6 @@
 # funlog
 
+<<<<<<< before updating
 `funlog` is a tiny but useful package that offers a few Python decorators to log
 function calls, with good control over what gets logged and when.
 
@@ -99,6 +100,44 @@ INFO:⏱ Function tallies:
     __main__.fibonacci() was called 465 times, total time 59.73s, avg per call 128ms
     __main__.sleep() was called 232 times, total time 9.11s, avg per call 39.25ms
 ```
+=======
+\[ **☞☞☞ This is the readme for a project from the
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv) template.** Fill it in and
+delete this message!
+Below are brief instructions on setup and development workflows that you may use or
+modify for your project.
+\]
+
+## Installing uv and Python
+
+This project is set up to use [**uv**](https://docs.astral.sh/uv/), the new package
+manager for Python. `uv` replaces traditional use of `pyenv`, `pipx`, `poetry`, `pip`,
+etc. This is a quick cheat sheet on that:
+
+On macOS or Linux, if you don't have `uv` installed, a quick way to install it:
+
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+For macOS, you prefer [brew](https://brew.sh/) you can install or upgrade uv with:
+
+```shell
+brew update
+brew install uv
+```
+
+See [uv's docs](https://docs.astral.sh/uv/getting-started/installation/) for more
+installation methods and platforms.
+
+Now you can use uv to install a current Python environment:
+
+```shell
+uv python install 3.13 # Or pick another version.
+```
+
+## Development
+>>>>>>> after updating
 
 There are several other options.
 See docstrings and [test_examples.py](tests/test_examples.py) for more docs and examples
@@ -107,4 +146,8 @@ on all the options.
 * * *
 
 *This project was built from
+<<<<<<< before updating
 [simple-modern-poetry](https://github.com/jlevy/simple-modern-poetry).*
+=======
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv).*
+>>>>>>> after updating

development.md

@@ -1,54 +1,80 @@
-## Development
+# Development
 
-[Fork](https://github.com/jlevy/kmd/fork) this repo (having your own fork will make it
-easier to contribute),
-[check out](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository),
-and then install the package dependencies:
+## Setting Up uv
 
-```shell
-poetry install
-```
+This project is set up to use [uv](https://docs.astral.sh/uv/) to manage Python and
+dependencies. First, be sure you
+[have uv installed](https://docs.astral.sh/uv/getting-started/installation/).
+
+Then [fork](https://github.com/jlevy/funlog/fork) this
+repo (having your own fork will make it easier to contribute) and
+[clone it](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
 
-Developer workflows:
+## Basic Developer Workflows
+
+The `Makefile` simply offers shortcuts to `uv` commands for developer convenience.
+(For clarity, GitHub Actions don't use the Makefile and just call `uv` directly.)
 
 ```shell
-# Run poetry install, lint, and test:
+# First, install all dependencies and set up your virtual environment.
+# This simply runs `uv sync --all-extras --dev` to install all packages,
+# including dev dependencies and optional dependencies.
+make install
+
+# Run uv sync, lint, and test:
 make
 
 # Build wheel:
 make build
 
-# Linting and testing individually:
+# Linting:
 make lint
+
+# Run tests:
 make test
 
 # Delete all the build artifacts:
 make clean
 
-# To run a shell within the Python environment:
-poetry shell
-# Thereafter you can run tests.
-
-# To run tests:
-pytest   # all tests
-pytest -s src/module/some_file.py  # one test, showing outputs
-
-# Poetry dependency management commands:
-# Upgrade all dependencies:
-poetry up
-# Update poetry itself: 
-poetry self update
+# Upgrade dependencies to compatible versions:
+make upgrade
+
+# To run tests by hand:
+uv run pytest   # all tests
+uv run pytest -s src/module/some_file.py  # one test, showing outputs
+
+# Build and install current dev executables, to let you use your dev copies
+# as local tools:
+uv tool install --editable .
+
+# Dependency management directly with uv:
+# Add a new dependency:
+uv add package_name
+# Add a development dependency:
+uv add --dev package_name
+# Update to latest compatible versions (including dependencies on git repos):
+uv sync --upgrade
+# Update a specific package:
+uv lock --upgrade-package package_name
+# Update dependencies on a package:
+uv add package_name@latest
+
+# Run a shell within the Python environment:
+uv venv
+source .venv/bin/activate
 ```
 
+See [uv docs](https://docs.astral.sh/uv/) for details.
+
 ## Release Process
 
 This project is set up to publish to [PyPI](https://pypi.org/) from GitHub Actions.
 
 Thanks to [the dynamic versioning
-plugin](https://github.com/mtkennerly/poetry-dynamic-versioning) and `publish.yml`
-workflow, you can simply create tagged releases (using standard format for the tag name,
-e.g. `v0.1.0`) on GitHub and the tag will trigger a release build, which then uploads it
-to PyPI.
+plugin](https://github.com/ninoseki/uv-dynamic-versioning/) and the
+[`publish.yml` workflow](.github/workflows/publish.yml), you can simply create tagged
+releases (using standard format for the tag name, e.g. `v0.1.0`) on GitHub and the tag
+will trigger a release build, which then uploads it to PyPI.
 
 For this to work you will need to have a PyPI account and authorize your repository to
 publish to PyPI. The simplest way to do that is on [the publishing settings
@@ -58,5 +84,5 @@ the project name, repo owner, repo name, and `publish.yml` as the workflow name.
 
 * * *
 
-*This file generated by
-[simple-modern-poetry](https://github.com/jlevy/simple-modern-poetry).*
+*This file was built with
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv).*