Home Original page

GitHub - joaopalmeiro/template-python-uv-script: Opinionated Python + uv template for new scripts.

uv Ruff Checked with mypy

Opinionated Python + uv template for new scripts.

Getting Started

  1. Go to or create the project folder.
  2. Get the template files:
npx giget github:joaopalmeiro/template-python-uv-script . --force
  1. Search for template-python-uv-script and replace it with the project name. Ignore the template repository URL in the NOTES.md file.
  2. 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.
  3. Search for João Palmeiro and replace it with the author's name.
  4. Open the requirements.txt file and add the project-specific dependencies.
  5. Delete the deprecated/ folder and the corresponding configuration in the .vscode/settings.json and ruff.toml files.
  6. Remove app-template/ from the .gitignore file.
  7. Delete the TEMPLATE.md file.
  8. Delete the Getting Started section.

Development

Install uv (if necessary):

curl -LsSf https://astral.sh/uv/0.11.6/install.sh | sh