feat: add uv support (#7)

Author: eckelsjd

.github/workflows/deploy.yml

@@ -15,13 +15,13 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: pdm-project/setup-pdm@v4
+    - uses: astral-sh/setup-uv@v7
       with:
-        python-version: 3.11
-        cache: true
-    - run: pdm sync  # Installs packages from pdm.lock (should be exactly the same every time this is run)
+        version: "0.10.8"
+        enable-cache: true
+    - run: uv tool install commitizen
     - name: Create release notes
-      run: pdm run cz changelog $(pdm run cz version --project) --dry-run > body.md
+      run: uv tool run --from commitizen cz changelog $(uv tool run --from commitizen cz version --project) --dry-run > body.md
     - uses: softprops/action-gh-release@v2
       with:
         body_path: body.md

README.md

@@ -1,8 +1,8 @@
 # Numpy project template
 [![Python 3.11](https://img.shields.io/badge/python-3.11+-blue.svg?logo=python&logoColor=cccccc)](https://www.python.org/downloads/) 
-[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org)
 [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://squidfunk.github.io/mkdocs-material/)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 ![Code Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
@@ -13,7 +13,7 @@ Construct a `numpy`-based Python project from scratch for scientific computing a
 ## :wrench: Features
 
 - [Numpy](https://numpy.org/) a basic installation for the holy trifecta :dove: of `numpy, matplotlib, scipy`.
-- [PDM](https://pdm-project.org) for dependency, virtualenv, and package management.
+- [pdm](https://pdm-project.org) or [uv](https://docs.astral.sh/uv/) for dependency, virtualenv, and package management.
 - [Mkdocs material](https://squidfunk.github.io/mkdocs-material/) for simple, clean, automated, online code documentation.
 - [pre-commit](https://github.com/pre-commit/pre-commit) with [ruff](https://github.com/astral-sh/ruff) integration for code linting and formatting.
 - [pytest](https://docs.pytest.org/en/stable/index.html#) with [coverage](https://pytest-cov.readthedocs.io/en/latest/) for regression testing and code coverage.
@@ -22,24 +22,23 @@ Construct a `numpy`-based Python project from scratch for scientific computing a
 - [Github actions](https://docs.github.com/en/actions) for automated, build, test, and deployment.
 
 ## :round_pushpin: Quickstart
-Have python and git installed, then:
+Install copier with extensions-
 ```shell
-pip install --user pdm
-pdm self add copier copier-templates-extensions
-
-cd path/to/project
-pdm init --copier gh:eckelsjd/copier-numpy --trust
+pdm self add copier copier-templates-extensions            # pdm, or
+uv tool install copier --with copier-templates-extensions  # uv
 ```
-That's it! Follow the questionnaire and then your `numpy`-based scientific computing project is ready to go. 
-
-All extra arguments are passed to `copier copy` (you're also welcome to just use `copier` directly).
+Then copy the template-
+```shell
+copier copy gh:eckelsjd/copier-numpy <dst_path> --trust
+```
+That's it! Follow the questionnaire and then your `numpy`-based scientific computing project is ready to go.
 
 ***Note:*** The `--trust` flag enables extensions used in this template. Please see [extensions.py](extensions.py) and [setup_github.py](setup_github.py) to make sure you trust this template (*spoiler:* these just add some global template variables and some basic `git` scripting).
 
 ## :snake: Publishing on PyPI
 Follow [this tutorial](https://docs.pypi.org/trusted-publishers/) to enable trusted publishing with Github actions. Then, do:
 ```shell
-pdm bump
+cz bump
 ```
 That's it! Your package will automatically deploy to PyPI and GitHub with a correctly-versioned `vX.X.X` tag.
 

TODO.md

@@ -25,13 +25,16 @@
 - [x] Newly copied repo should install pre-commit and setup
 - [x] Add license file automatically
 - [ ] Option in `setup_github.py` to detect and change who is logged in to gh CLI (or exit)
-- [ ] Migrate amisc/uqtils to this template and check the usage of `copier update`.
+- [x] Migrate amisc/uqtils to this template and check the usage of `copier update`.
 - [x] Make sure this all works in linux too (works on ubuntu at least)
 
+# Agents
+- [ ] Look into templates for agent skills and configuration.
+
 # General workflow
-1. User should be running `pdm test` and `pdm lint` to make sure their code works and is up to snuff.
+1. User should be running `dev.py test` and `dev.py lint` to make sure their code works and is up to snuff.
 1. `pre-commit` will lint, check for sensitive data, check for an up to date `pytest` run, etc. and check that commit message is formatted correctly. Will block if lint or tests failed. README coverage badge automatically updated after `pytest`.
 1. Then the user manually fixes lint/test errors. Can also use `ruff check --fix` to automatically fix lint errors. No formatting is forced at this time but would be easy with `ruff format`.
 1. On pull request to main, a GHA will run all the `pytest` and `ruff checks` again on multiple versions/platforms.
 1. On commit to main, another test-coverage is generated and read into automatic gh-pages deploy for coverage report.
-1. With a manual `pdm bump`, a new tag/version/release/changelog/build are generated from commit history and released. Uses `commitizen` under the hood to manage this.
+1. With a manual `cz bump`, a new tag/version/release/changelog/build are generated from commit history and released.

copier.yml

@@ -12,8 +12,6 @@ _message_before_copy: |
   tailored project for you.
 _message_after_copy: |
   Your project "{{ project_name }}" has been created successfully!
-  
-  Run `pdm setup_dev` to initialize a dev environment. Run `pdm install` to add all dependencies.
 _message_before_update: |
   Thanks for updating your project using the numpy template.
   
@@ -26,60 +24,65 @@ _message_after_update: |
 
 # POST COPY TASKS (only on init)-------------------------
 _tasks:
-  - command: "pdm lock"
-    when: "{{ not is_copier_update }}"
   - command:
       - 'powershell'
       - '-command'
       - >
          $tempFilePath = [System.IO.Path]::GetTempFileName() + ".py";
          Invoke-WebRequest -Uri https://raw.githubusercontent.com/eckelsjd/copier-numpy/{{ _copier_conf.vcs_ref_hash }}/setup_github.py -OutFile $tempFilePath;
-         pdm run python $tempFilePath;
+         {{ python_manager }} run {% if python_manager == 'uv' %}--no-project{% endif %} python $tempFilePath;
          Remove-Item $tempFilePath;
-    when: "{{ _copier_conf.os == 'windows' and init_github and not is_copier_update }}"
+    when: "{{ _copier_conf.os == 'windows' and init_github and _copier_operation == 'copy' and (python_manager | manager_exists) }}"
   - command: > 
               export temp_file=$(mktemp).py;
               curl -sSL https://raw.githubusercontent.com/eckelsjd/copier-numpy/{{ _copier_conf.vcs_ref_hash }}/setup_github.py --output "$temp_file";
-              pdm run python "$temp_file";
+              {{ python_manager }} {% if python_manager == 'uv' %}--no-project{% endif %} run python "$temp_file";
               rm "$temp_file";
-    when: "{{ _copier_conf.os in ['linux', 'macos'] and init_github and not is_copier_update }}"
+    when: "{{ _copier_conf.os in ['linux', 'macos'] and init_github and _copier_operation == 'copy' and (python_manager | manager_exists) }}"
 
 # PROMPT ---------------------------------
 project_name:
   type: str
   help: "Enter your project name:"
-  default: "{{ project_dir }}"
+  default: "{{ _folder_name }}"
 
 project_description:
   type: str
   help: "Enter a project description:"
 
-author_name:
+python_manager:
+  type: str
+  help: "Which Python project manager do you prefer?"
+  default: uv
+  choices:
+    - uv
+    - pdm
+
+user_name:
   type: str
   help: "Enter your full name:"
   default: "{{ git_user_name }}"
 
-author_email:
+user_email:
   type: str
   help: "Enter your email:"
   default: "{{ git_user_email }}"
 
 repository_namespace:
   type: str
   help: "Enter your repository namespace (e.g. your username/org on GitHub):"
-  default: "{{ git_username }}"
+  default: "{{ github_user }}"
 
 is_distributable:
   type: bool
-  help: "Do you want to build this project as a package for distribution (e.g. pip install)?"
+  help: "Is this a Python library?"
   default: false
 
 distribution_name:
   type: str
   help: "Your Python package distribution name (for `pip install NAME`):"
   default: "{{ project_name | slugify }}"
   when: "{{ is_distributable }}"
-#  validator: "{% if distribution_name | pypi_name_exists %}`{{ distribution_name }}` already exists on https://pypi.org. Please choose a unique package name.{% endif %}"
 
 import_name:
   type: str

extensions.py

@@ -3,10 +3,8 @@
 import subprocess
 import unicodedata
 from datetime import date
-from pathlib import Path
-import os
 import urllib.request
-import urllib
+import urllib.error
 
 from jinja2.ext import Extension
 
@@ -39,23 +37,6 @@ def slugify(value, separator="-"):
     return re.sub(r"[-_\s]+", separator, value).strip("-_")
 
 
-def pypi_name_exists(package_name: str) -> bool:
-    """Check if a package name exists in PyPI."""
-    url = f'https://pypi.org/project/{package_name}'
-    try:
-        urllib.request.urlopen(url)
-        return True
-    except urllib.error.HTTPError as e:
-        if e.code == 404:
-            return False
-        else:
-            raise
-
-
-def path_exists(path: str) -> bool:
-    return Path(path).exists()
-
-
 def format_python_version(version: str) -> str:
     """Just return the first x.x version number of a Python PEP508 version specifier"""
     first_version = version.split(",")[0]
@@ -69,19 +50,21 @@ def format_python_version(version: str) -> str:
             f"{'+' if '>' in first_version else ''}")
 
 
+def manager_exists(manager_name: str) -> bool:
+    """Check if a Python project manager is installed."""
+    return shutil.which(manager_name) is not None
+
+
 class TemplateDefaultExtension(Extension):
     """Provide some default answers as global variables to speed up template initialization"""
     def __init__(self, environment):
         super().__init__(environment)
         email = git_user_email('')
         environment.globals["git_user_name"] = git_user_name('')
         environment.globals["git_user_email"] = email
-        environment.globals["git_username"] = email.split('@')[0]
+        environment.globals["github_user"] = email.split('@')[0]
         environment.globals["current_year"] = date.today().year
-        environment.globals["project_dir"] = Path(os.getcwd()).resolve().name
-        environment.globals["is_copier_update"] = path_exists(".copier-answers.yml") or path_exists(".copier-answers.yaml")
-        # runs *before* update/copy, so answers.yml will only exist when we are doing copier update
 
-        environment.filters["pypi_name_exists"] = pypi_name_exists
         environment.filters["slugify"] = slugify
         environment.filters["format_python_version"] = format_python_version
+        environment.filters["manager_exists"] = manager_exists

pyproject.toml

@@ -22,16 +22,7 @@ changelog_file = "CHANGELOG.md"
 annotated_tag = true
 post_bump_hooks = ["git push --follow-tags"]
 
-[tool.pdm]
-distribution = false
-
-[tool.pdm.install]
-cache = true
-
-[tool.pdm.scripts]
-bump = "cz bump {args}"
-
-[tool.pdm.dev-dependencies]
+[dependency-groups]
 dev = [
     "commitizen>=3.29.0",
     "pre-commit>=3.8.0",

setup_github.py

@@ -59,7 +59,7 @@ def run_command(command, capture_output=True, text=None, shell=False):
         else:
             if not shell:
                 command = shlex.split(command)
-        return subprocess.run(command, capture_output=capture_output, check=True, text=text, shell=shell)
+        return subprocess.run(command, capture_output=capture_output, check=True, text=text, shell=shell, env=os.environ.copy())
     except subprocess.CalledProcessError as e:
         raise RuntimeError(f"Command `{command}` failed with code {e.returncode}: {e}\nError message: {e.stderr}") from e
     except subprocess.SubprocessError as e:
@@ -235,14 +235,14 @@ def initialize_git_repo_settings():
             # Create the gh-pages branch and link to Github pages (might fail if it already exists)
             run_command("git branch gh-pages")
             run_command("git push --set-upstream origin gh-pages")  # automatically creates the GitHub pages site
-            # run_command('gh api --method POST "/repos/{owner}/{repo}/pages" -f "source[branch]=gh-pages"')
+            # run_command('gh api --method POST "/repos/{owner}/{repo}/pages" -f "source`[branch`]=gh-pages"')
         except Exception as e:
             print(f'Problem setting up GitHub Pages: {e}\nSkipping...')
 
     # Add Github basic settings
     try:
         pyproj_values = parse_pyproject_toml(keys=["description"])
-        topics = [f"--add-topic {topic}" for topic in ["pdm", "python", "numpy"]]
+        topics = [f"--add-topic {topic}" for topic in ["python", "numpy"]]
         extra_options = ["--delete-branch-on-merge", "--enable-discussions", "--enable-issues", "--enable-wiki=false",
                          "--enable-projects=false", "--enable-merge-commit=false", "--enable-rebase-merge",
                          "--enable-squash-merge", "--allow-update-branch",

template/README.md.jinja

@@ -1,7 +1,7 @@
 {%- if include_docs -%}![Logo](https://raw.githubusercontent.com/{{repository_namespace}}/{{ project_name }}/main/docs/assets/logo.svg){%- else -%}
 # {{ project_name }}{%- endif %}
-
-[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org)
+{%- if python_manager == 'pdm' %}[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm-project.org){%- endif %}
+{%- if python_manager == 'uv' %}[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv){%- endif %}
 [![Python version](https://img.shields.io/badge/python-{{ python_version }}-blue.svg?logo=python&logoColor=cccccc)](https://www.python.org/downloads/)
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/eckelsjd/copier-numpy)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -22,17 +22,12 @@
 
 {{ project_description }}
 
-{% if is_distributable %} ## ⚙️ Installation
+{% if is_distributable %}
+## ⚙️ Installation
 ```shell
 pip install {{ distribution_name }}
 ```
-If you are using [pdm](https://github.com/pdm-project/pdm) in your own project, then you can use:
-```shell
-pdm add {{ distribution_name }}
-
-# Or in editable mode from a local clone...
-pdm add -e ./{{ distribution_name }} --dev
-```{%- endif %}
+{% endif %}
 
 ## 📍 Quickstart
 ```python
@@ -43,8 +38,10 @@ import {{ import_name }}
 print('Wow!')
 ```
 
-{% if is_distributable %} ## 🏗️ Contributing
-See the [contribution](https://github.com/{{ repository_namespace }}/{{ project_name }}/blob/main/CONTRIBUTING.md) guidelines.{%- endif %}
+{% if is_distributable %}
+## 🏗️ Contributing
+See the [contribution](https://github.com/{{ repository_namespace }}/{{ project_name }}/blob/main/CONTRIBUTING.md) guidelines.
+{% endif %}
 
 ## Citations
 Include any additional references for your project.

template/dev.py.jinja

@@ -0,0 +1,54 @@
+"""A simple development script to run common tasks. 
+
+Available: test, bump, docs, lint, setup.
+Usage: `python dev.py <function_name> [args...]`
+"""
+import sys
+import subprocess
+
+
+def test(*args):
+    subprocess.run(["pytest", "--cov={{ import_name }}", "--cov-report", "html:htmlcov", "tests"] + list(args))
+
+
+def bump(*args):
+    subprocess.run(["cz", "bump"] + list(args))
+
+
+def docs(*args):
+    subprocess.run(["mkdocs", "serve"] + list(args))
+
+
+def lint(*args):
+    subprocess.run(["ruff", "check", "src", "tests"] + list(args))
+
+
+def setup(*args):
+    subprocess.run(["{{ python_manager }}", "sync", "--group", "dev"])
+    {% if init_github %}subprocess.run(["pre-commit", "install", "--allow-missing-config"]){% endif %}
+    {% if install_jupyter %}subprocess.run(["nbstripout", "--install"]){% endif %}
+
+
+FUNCTIONS = {
+    "test": test, 
+    "bump": bump,
+    "docs": docs,
+    "lint": lint,
+    "setup": setup
+}
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("Usage: python dev.py <function_name> [args...]")
+        sys.exit(1)
+    
+    func_name = sys.argv[1]
+    args = sys.argv[2:]
+    
+    if func_name not in FUNCTIONS:
+        print(f"Error: Function '{func_name}' not found")
+        sys.exit(1)
+    
+    func = FUNCTIONS[func_name]
+    func(*args)