Added support for the uv package and project manager (#408)

* Added light compatibility with my own repository

* Copied over uv harness

* Added uv to ccds.json and ccds-help.json as well as added it to the makefile. Is untested.

* Simplified harness and added it to valid environment managers

* Minor simplifications to harness and virtualenv + Makefile

* Updated uv and requirements.txt to use uv instead of default pip

* Made uv install requested python version

* Added uv to dev-requirements.txt and removed redundant pip install from makefile

* revert gitignore and pyproject.toml changes

* add newline at end of venv harness

* remove uv pip install pip (unnecessary)

* add newline to uv_harness

* add lint and format makefile test commands per #387

---------

Co-authored-by: Chris Kucharczyk <[email protected]>

Author: GatlenCulp

ccds-help.json

@@ -140,6 +140,13 @@
                     "more_information": "[Docs](https://pipenv.pypa.io/en/latest/)"
                 } 
             },
+            {
+                "choice": "uv",
+                "help": {
+                    "description": "An extremely fast Python package and project manager, written in Rust.",
+                    "more_information": "[Docs](https://docs.astral.sh/uv/)"
+                } 
+            },
             {
                 "choice": "none",
                 "help": {

ccds.json

@@ -15,6 +15,7 @@
         "virtualenv",
         "conda",
         "pipenv",
+        "uv",
         "none"
     ],
     "dependency_file": [

dev-requirements.txt

@@ -15,5 +15,6 @@ pipenv
 pytest
 termynal
 twine
+uv
 virtualenvwrapper; sys_platform != 'win32'
 virtualenvwrapper-win; sys_platform == 'win32'

tests/test_creation.py

@@ -169,6 +169,8 @@ def verify_makefile_commands(root, config):
         harness_path = test_path / "virtualenv_harness.sh"
     elif config["environment_manager"] == "pipenv":
         harness_path = test_path / "pipenv_harness.sh"
+    elif config["environment_manager"] == "uv":
+        harness_path = test_path / "uv_harness.sh"
     elif config["environment_manager"] == "none":
         return True
     else:

tests/uv_harness.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+set -ex
+
+PROJECT_NAME=$(basename $1)
+CCDS_ROOT=$(dirname $0)
+MODULE_NAME=$2
+
+# Configure exit / teardown behavior
+function finish {
+    # Deactivate venv if we're in one
+    if [[ $(which python) == *"$PROJECT_NAME"* ]]; then
+        deactivate
+    fi
+    # Clean up venv directory
+    if [ -d ".venv" ]; then
+        rm -rf .venv
+    fi
+}
+trap finish EXIT
+
+# Source the steps in the test
+source $CCDS_ROOT/test_functions.sh
+
+# Navigate to the generated project and run make commands
+cd $1
+make
+
+# Create and activate virtual environment
+make create_environment
+
+
+# Check if running on Windows and use appropriate activate path
+if [[ "$OSTYPE" == "msys"* || "$OSTYPE" == "cygwin"* ]]; then
+    source ".venv/Scripts/activate"
+else
+    source ".venv/bin/activate"
+fi
+
+make requirements
+make lint
+make format
+
+run_tests $PROJECT_NAME $MODULE_NAME

tests/virtualenv_harness.sh

@@ -59,4 +59,3 @@ make lint
 make format
 
 run_tests $PROJECT_NAME $MODULE_NAME
-

{{ cookiecutter.repo_name }}/Makefile

@@ -15,8 +15,12 @@ PYTHON_INTERPRETER = python
 .PHONY: requirements
 requirements:
 	{% if "requirements.txt" == cookiecutter.dependency_file -%}
+	{% if "uv" == cookiecutter.environment_manager -%}
+	uv pip install -r requirements.txt
+	{% else -%}
 	$(PYTHON_INTERPRETER) -m pip install -U pip
 	$(PYTHON_INTERPRETER) -m pip install -r requirements.txt
+	{% endif -%}
 	{% elif "environment.yml" == cookiecutter.dependency_file -%}
 	conda env update --name $(PROJECT_NAME) --file environment.yml --prune
 	{% elif "Pipfile" == cookiecutter.dependency_file -%}
@@ -103,6 +107,11 @@ create_environment:
 	{% elif cookiecutter.environment_manager == 'pipenv' -%}
 	pipenv --python $(PYTHON_VERSION)
 	@echo ">>> New pipenv created. Activate with:\npipenv shell"
+	{% elif cookiecutter.environment_manager == 'uv' -%}
+	uv venv --python $(PYTHON_VERSION)
+	@echo ">>> New uv virtual environment created. Activate with:"
+	@echo ">>> Windows: .\\\\.venv\\\\Scripts\\\\activate"
+	@echo ">>> Unix/macOS: source ./.venv/bin/activate"
 	{% endif %}
 {% endif %}