joaopalmeiro / template-python-uv-notebook

Opinionated Python + uv template for new notebooks.

template-python-uv-notebook

Opinionated Python + uv template for new notebooks.

Getting Started

1. Go to or create the project folder.
2. Get the template files:

npx degit github:joaopalmeiro/template-python-uv-notebook

or

npx degit github:joaopalmeiro/template-python-uv-notebook --force

3. Search for template-python-uv-notebook and replace it with the project name. Ignore the template repository URL in the NOTES.md file.
4. Search for Opinionated [Python](https://www.python.org/) + [uv](https://github.com/astral-sh/uv) template for new notebooks. and replace it with the (short) project description.
5. Search for João Palmeiro and replace it with the author's name.
6. Open the requirements.txt file and add the project-specific dependencies.
7. Delete the TEMPLATE.md file.
8. Delete the Getting Started section.

Development

Install pyenv (if necessary).

pyenv install && pyenv versions

pip install uv==0.1.24 && uv --version

uv venv .venv

source .venv/bin/activate

which python && python --version

uv pip install -r requirements.txt

uv pip list --strict

uv pip check --verbose

jupyter lab

ruff check

ruff check --fix

ruff format

deactivate