python-package

Python Package Scaffold

Use this structure as the starting point for a new Python package. Update the description, dependencies, and dev dependencies based on context.

src/<package>/__init__.py:

def main() -> None:
    print("Hello from <package>!")

.python-version:

3.13

pyproject.toml:

[project]
name = "<package>"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
authors = [
    { name = "Author Name", email = "author@example.com" }
]
requires-python = ">=3.13"
dependencies = []

[project.scripts]
<package> = "<package>:main"

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.ruff]
preview = true

[tool.ruff.lint]
select = ["F", "E", "W"]
extend-select = ["I"]
extend-safe-fixes = ["F401", "F841"]

Lint and Format

Run both ruff checks before the first commit and again after every later edit to a Python file.

ruff check and ruff format are separate tools, and a project can pass one while failing the other.

uv tool run ruff check /absolute/path/to/<package>

uv tool run ruff format /absolute/path/to/<package>

Confirm with uv tool run ruff format --check /absolute/path/to/<package>, which exits 1 when any file would change.

Run each as its own Bash call.

Show Version

Support --version using importlib.metadata so the version is not duplicated:

import argparse
import importlib.metadata

parser = argparse.ArgumentParser(description="...")
parser.add_argument(
    "--version",
    action="version",
    version=f"%(prog)s {importlib.metadata.version('<package>')}"
)

About this skill

Python Package Scaffold

Lint and Format

Show Version