adeshmukh/init-python

Init Python

Set up a modern Python project with uv + ruff.

Arguments

$0 — project name. If not provided, default to the current directory name.

Steps

1. Pre-flight checks

• Verify uv is installed by running uv --version. If not found, tell the user to install it: curl -LsSf https://astral.sh/uv/install.sh | sh
• Check if pyproject.toml already exists. If it does, stop and inform the user that the project appears to be already initialized.

2. Initialize with uv

Run:

uv init <project-name>

If $0 is empty, run uv init (uses the current directory name).

If the current directory is not empty and uv init needs to create in-place, use:

uv init .

3. Configure ruff in pyproject.toml

Read the generated pyproject.toml and add the following ruff configuration sections. Use the Edit tool to append to the file:

[tool.ruff]
line-length = 120
target-version = "py312"

[tool.ruff.lint]
select = ["E", "F", "I", "N", "W", "UP"]

Rule groups explained:

• E — pycodestyle errors
• F — pyflakes
• I — isort (import sorting)
• N — pep8-naming
• W — pycodestyle warnings
• UP — pyupgrade

4. Create .python-version

Check if .python-version exists. If not, create it with:

3.12

5. Migrate requirements.txt (if present)

Check if requirements.txt exists. If it does:

1. Read the file
2. For each non-comment, non-empty line, run:

   uv add <package>
   

3. After all packages are added, inform the user that the migration is complete and they can safely remove requirements.txt

6. Sync and verify

Run:

uv sync

Then verify the setup:

uv run ruff check .

If ruff reports issues, show them to the user but do not fail — these are pre-existing issues in any migrated code.

7. Report

Tell the user:

• The project has been initialized with uv
• Ruff is configured with the selected rules
• Python version target
• If requirements were migrated
• Suggest next steps (e.g. uv add <package>, uv run python main.py)