scaldys-project

scaldys-project automates the complete Windows distribution pipeline for Python projects. A single command takes your source code through Sphinx documentation, optional Cython compilation, and — depending on the chosen deployment mode — one of three distribution strategies:

• wheel_only (default) — binary wheel only, no installer (for pip-installable apps)
• pyinstaller — PyInstaller exe + Inno Setup installer
• pyruntime — binary wheel + Inno Setup installer with a managed Python runtime (for apps that coexist with Quarto/Jupyter)

If you are starting a new project, use scaldys-project init to scaffold one from scaldys-template in a single command. The interactive wizard collects your project name, author details, and deployment mode, then downloads the template, substitutes all placeholder names, and optionally runs git init and uv sync:

scaldys-project init

scaldys-template provides a ready-to-use scaffold with scaldys-project already integrated: packaging scripts, Sphinx documentation, CI/CD workflows, and a working scaldys-project.toml.

For a full guide on using and integrating scaldys-project in your project, see the user documentation.

Development

This section is for contributors working on scaldys-project itself.

Project repository and issue tracker: https://github.com/scaldys/scaldys-project

Quick start

git clone https://github.com/scaldys/scaldys-project.git
cd scaldys-project
uv sync --group dev
uv run pytest
uv run ruff check src tests && uv run pyright

Upgrading dependencies

To automatically "bump" the version constraints in pyproject.toml to their latest versions, you have two primary options:

1. Recommended: uv-upgrade
   The community-developed uv-upgrade tool specifically handles this workflow. You can run it without permanent installation using uvx:

   uvx uv-upgrade
   

2. Native uv Workflow
   You can update specific packages manually using uv add <package>. To update the lockfile (uv.lock) while respecting your current constraints, use:

   uv lock --upgrade
   

Further reading

The manual's Developers section covers everything else a contributor needs:

• Architecture — module layout, three-class composition pattern, execution flow, configuration loading, and why compile_runner.py runs as a subprocess
• Extension Points — design conventions and how to add Cython modules, build steps, or a new platform builder
• Contributing — linting, type checking, building docs, versioning, and publishing