joaopalmeiro / template-python-uv-script

Opinionated Python + uv template for new scripts.

template-python-uv-script

Opinionated Python + uv template for new scripts.

Getting Started

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

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

or

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

3. Search for template-python-uv-script 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 scripts. 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. Remove , TEMPLATE.md from the README.md file nesting pattern in the .vscode/settings.json file.
8. Delete the TEMPLATE.md file.
9. Delete the Getting Started section.

Development

Install pyenv (if necessary).

pyenv install && pyenv versions

pip install uv==0.1.39 && uv --version

uv venv .venv --verbose

source .venv/bin/activate

which python && python --version

uv pip install -r requirements.txt

uv pip list --strict

uv pip check --verbose

ruff check

mypy

ruff check --fix

ruff format

python 01.py

deactivate