Merge pull request #44 from claui/migrate-to-uv

Migrate from Poetry to uv

Author: claui

CONTRIBUTING.md

@@ -3,97 +3,42 @@
 ## Requirements for contributing
 
 To contribute to the `cookiecutter-python-package` template,
-you’ll need:
+you’ll need the project management tool
+[uv](https://docs.astral.sh/uv).
 
-1. The Python version manager `pyenv`.
+### Installing uv
 
-2. The Python dependency manager `poetry`.
+To install uv, see its
+[installation instructions](https://docs.astral.sh/uv/getting-started/installation/).
 
-### Installing Poetry
+#### Checking your uv installation
 
-You’ll need `poetry` to manage development dependencies and the venv.
-
-#### Installing Poetry on Windows
-
-To install Poetry on Windows, use one of the
-[installation methods](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
-described in Poetry’s documentation.
-
-#### Installing Poetry on Linux
-
-If you’re on Linux or WSL2, use your system package manager to
-install Poetry.
-
-Alternatively, use one of the
-[installation methods](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
-described in Poetry’s documentation.
-
-#### Installing Poetry on macOS
-
-To install Poetry on macOS, run:
-
-```shell
-brew install poetry
-```
-
-#### Checking your Poetry installation
-
-To verify Poetry is working, run:
+To verify uv is working, run:
 
 ```shell
-poetry --version
+uv
 ```
 
 #### Installing Cookiecutter as a stand-alone tool (optional)
 
 Cookiecutter is already included as a development dependency,
-so Poetry will take care of installing it for you.
+so uv will take care of installing it for you.
 You don’t need to have it installed as a stand-alone tool, but you
 may still want to do so for your convenience.
 
 To install Cookiecutter as a stand-alone tool, follow Cookiecutter’s [installation
 instructions](https://cookiecutter.readthedocs.io/en/stable/installation.html).
 
-## Setting up your virtual environment
-
-To set up your virtual environment, follow these steps:
-
-1. Go to the project root directory.
-
-2. Run `pyenv install -s`.
-
-3. Run `pyenv exec python -m venv .venv`.
-
-4. Run `poetry install`.
-
-You need to do the above steps only once.
-
-To update your dependencies after a `git pull`, run `poetry install`.
-
 ## Development scripts and tasks
 
-To see a list of available tasks, run: `poetry run poe tasks`
+To see a list of available tasks, run: `uv run poe tasks`
 
 ## Running the end-to-end test
 
-To execute the end-to-end test, run: `poetry run poe e2e`
+To execute the end-to-end test, run: `uv run poe e2e`
 
 ## FAQ
 
-Q: Why is `pyenv` required even though Cookiecutter accepts any
-Python version?
-
-A: Especially because Cookiecutter accepts any Python version,
-you’ll want your code to work equally well on all of those supported
-Pythons. We achieve that by pinning the minimum Python version
-that Cookiecutter supports as our development dependency.
-
-Q: Do I have to add `pyenv` shims to my PATH?
-
-A: No, because this guide
-[doesn’t use pyenv’s shims](https://github.com/pyenv/pyenv#using-pyenv-without-shims).
-It’s still ok to have them in your PATH if you prefer so.
-
 Q: Why is Cookiecutter a development dependency even though I
 already have a stand-alone Cookiecutter install?
 

README.md

@@ -65,7 +65,7 @@ The Cookiecutter template will give you:
 
 - a global settings file that all modules can import;
 
-- a `pyproject.toml` file and an initial Poetry lockfile;
+- a `pyproject.toml` file and an initial `uv.lock` file;
 
 - a default linter configuration;
 
@@ -76,7 +76,7 @@ The Cookiecutter template will give you:
 - a configuration file for Read the Docs;
 
 - a set of `poe` tasks for running the module scripts, tests and the
-  linter (for details, run `poetry run poe tasks`);
+  linter (for details, run `uv run poe tasks`);
 
 - a virtual environment with initial dependencies installed and
   ready to use;
@@ -95,117 +95,36 @@ The Cookiecutter template will give you:
 
 To use this Cookiecutter template, you need:
 
-1. The Python version manager `pyenv`.
+1. The Python project management tool [uv](https://docs.astral.sh/uv).
 
-2. A system-wide Python installation.
+2. Optionally, Cookiecutter version 2.6.0 or newer.  
 
-3. Cookiecutter version 2.6.0 or newer.
+### Installing uv
 
-4. The Python dependency manager `poetry`.
+To install uv, see its
+[installation instructions](https://docs.astral.sh/uv/getting-started/installation/).
 
-### Installing pyenv
-
-You need the Python version manager `pyenv` so you can set up your
-generated package, and to make sure you can always keep that package
-up and running, regardless of your system Python.
-
-#### Installing pyenv on Windows
-
-While `pyenv` doesn’t support Windows, you can use a drop-in
-replacement called `pyenv-win`.
-
-To install `pyenv-win` on Windows, go to
-[github.com/pyenv-win/pyenv-win](https://github.com/pyenv-win/pyenv-win#installation)
-and follow one of the installation methods.
-
-#### Installing pyenv on Linux
-
-To install `pyenv` on Linux or WSL2, first make sure Python 3 is
-installed. Then follow the _Basic GitHub Checkout_ method described
-at [github.com/pyenv/pyenv](https://github.com/pyenv/pyenv#basic-github-checkout).
-
-#### Installing pyenv on macOS
-
-To install `pyenv` on macOS, run:
-
-```shell
-brew install pyenv
-```
-
-#### Checking your system-wide pyenv installation
-
-To verify your `pyenv` is working, run:
-
-```shell
-pyenv --version
-```
-
-### Checking your system-wide Python installation
-
-Make sure you have Python 3.8 or higher installed on your system
-and available in your PATH.
-
-To check, run:
-
-```shell
-python --version
-```
-
-If that fails, try:
+To verify uv is working, run:
 
 ```shell
-python3 --version
+uv
 ```
 
-Proceed after you’ve confirmed one of those to work.
-
 ### Installing Cookiecutter
 
-To install Cookiecutter, follow Cookiecutter’s [installation
-instructions](https://cookiecutter.readthedocs.io/en/stable/installation.html).
-
-### Installing Poetry
-
-You’ll need `poetry` to manage the generated Python package.
-
-#### Installing Poetry on Windows
-
-To install Poetry on Windows, use one of the
-[installation methods](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
-described in Poetry’s documentation.
-
-#### Installing Poetry on Linux
-
-If you’re on Linux or WSL2, use your system package manager to
-install Poetry.
-
-Alternatively, use one of the
-[installation methods](https://python-poetry.org/docs/master/#installing-with-the-official-installer)
-described in Poetry’s documentation.
+Installing Cookiecutter is optional, because you can run
+`uvx cookiecutter` without installing Cookiecutter.
 
-#### Installing Poetry on macOS
-
-To install Poetry on macOS, run:
-
-```shell
-brew install poetry
-```
-
-#### Checking your Poetry installation
-
-To verify Poetry is working, run:
-
-```shell
-poetry --version
-```
+If you prefer to install Cookiecutter, follow Cookiecutter’s [installation
+instructions](https://cookiecutter.readthedocs.io/en/stable/installation.html).
 
 ### Basic usage
 
 To run the template generator, make sure you have a working
 Cookiecutter installation. Then run:
 
 ```shell
-cookiecutter gh:claui/cookiecutter-python-package
+uvx cookiecutter gh:claui/cookiecutter-python-package
 ```
 
 ### Alternative usage
@@ -221,12 +140,12 @@ abbreviations:
 Then, to generate a project, run:
 
 ```shell
-cookiecutter python
+uvx cookiecutter python
 ```
 
 ## License
 
-Copyright (c) 2021 – 2024 Claudia Pellegrino <[email protected]>
+Copyright (c) 2021 – 2025 Claudia Pellegrino <[email protected]>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

hooks/post_gen_project.py

@@ -30,50 +30,12 @@
 {% endif -%}
 
 {%- if cookiecutter.install_dependencies_now == "y" %}
-def sysexit_formatted(message: str) -> None:
-    width = max((len(line) for line in message))
-    print('', width * '-', *message, width * '-',
-        file=sys.stderr, sep='\n')
-    sys.exit()
-
-pyenv_commands = [
-    'pyenv install -s',
-    'pyenv exec python -m venv .venv',
-]
-
 try:
-    for pyenv_command in pyenv_commands:
-        subprocess.run(pyenv_command, check=True, shell=True)
-except subprocess.CalledProcessError as e:
-    sysexit_formatted([
-        f'Pyenv failed with exit code {e.returncode}.',
-        'Go to the {{ cookiecutter.pypi_package_name }}'
-            ' directory and re-run:',
-        *[
-            f'    {command}'
-            for command in pyenv_commands + ['poetry install']
-        ],
-    ])
-
-poetry_environment = os.environ.copy()
-poetry_environment.update({
-    'LANG': poetry_environment.get('LANG', 'en_US.UTF-8'),
-    # https://github.com/python-poetry/poetry/issues/1917
-    'PYTHON_KEYRING_BACKEND': 'keyring.backends.null.Keyring',
-})
-
-logger.info('Running poetry. This may take a while.')
-try:
-    subprocess.run(
-        'poetry install',
-        env=poetry_environment,
-        check=True,
-        shell=True,
-        stdout=sys.stderr,
-    )
+    subprocess.run(['uv', 'python', 'install'], check=True, stdout=sys.stderr)
+    subprocess.run(['uv', 'lock'], check=True, stdout=sys.stderr)
 except subprocess.CalledProcessError as e:
     print(
-        f'Poetry failed with exit code {e.returncode}.',
+        f'uv failed with exit code {e.returncode}.',
         'Fix any issues, then go to the '
         '{{ cookiecutter.pypi_package_name }} directory and re-run:',
         f'    {e.cmd}',

hooks/pre_gen_project.py

@@ -35,10 +35,10 @@
         == '{{ cookiecutter.first_module_name }}':
     sys.exit('Package name and first module name cannot be the same')
 
-if not shutil.which('poetry'):
+if not shutil.which('uv'):
     sys.exit(
         """
-This Cookiecutter template depends on Poetry.
-For instructions on how to install Poetry, see `README.md`.
+This Cookiecutter template depends on uv.
+For instructions on how to install uv, see `README.md`.
 """
     )