Welcome to scaldys-project’s documentation!

scaldys-project automates the complete Windows distribution pipeline for Python projects — from Sphinx documentation through Cython compilation, PyInstaller bundling, and Inno Setup installer creation — all driven by a single command.

If you are starting a new project, scaldys-template gives you a ready-to-use project scaffold with scaldys-project already integrated: packaging scripts, Sphinx documentation, CI/CD workflows, and a working scaldys-project.toml — nothing to wire up manually.

Start with the Overview for a high-level picture, or jump straight to Installation and Quick Start to get up and running.

Documentation Contents

Users

• Overview
  • What scaldys-project does for you
  • The build pipeline at a glance
  • Getting started quickly with scaldys-template
  • Where to go next
• Installation
  • Requirements
  • Installing as a development dependency
  • Optional extras
  • Using a local development version
  • Verifying the installation
  • External tool dependencies
• Quick Start
  • Starting a new project
  • Adding to an existing project
• CLI Reference
  • Options
  • Command tree
  • init
  • check
  • test
  • ci all
  • ci lint
  • ci format
  • ci typecheck
  • ci markdown
  • ci doclint
  • ci build
  • build all
  • build docs
  • build windows
  • build clean
  • publish
  • format all
  • format python
  • format markdown
  • Global behaviour
• In-Depth Guides
  • Project Initialisation
  • Project Layout
  • Configuration
  • scaldys-project.toml — Full Reference
  • Project Compliance
  • Documentation Building
  • Cython Compilation
  • Windows Distribution Modes
  • Windows Installer Creation
  • Guide summaries

Developers

• Architecture
  • The Three-Class Composition Pattern
  • Execution Flow
  • Configuration Loading
  • Why compile_runner.py Runs as a Subprocess
• init Command — Internals
  • Overview
  • Module structure
  • Template acquisition
  • Exclusion list
  • Replacement ordering
  • Binary file detection
  • Path renaming
  • Targeted post-processing
  • Error handling and cleanup
  • Extending the command
• Extension Points
  • Design Conventions
  • Adding a New Cython Module to a Consuming Project
  • Adding a New Build Step to WindowsBuilder.main()
  • Adding a New Platform Builder
• Contributing
  • Development Setup
  • Reporting Issues
• Publishing
  • Overview
  • Why automated publishing?
  • Prerequisites
  • Step 1 — PyPI Trusted Publishing
  • Step 2 — GitHub Environment
  • Step 3 — GitHub Pages Configuration
  • Step 4 — Workflow Files
  • Step 5 — Version Bump
  • Step 6 — Trigger a Release
  • TestPyPI Dry Run
• Markdown Formatting and Tools
  • Why mdformat for Markdown?
  • Target File Scoping
  • CI Drift Detection
  • Command Summary
  • Local Workflow
  • GitHub Actions CI

About

• Changelog
• Authors
• License
• Get Help

Indices and tables

• Index

• Module Index

• Search Page