Skip to content

Repository files navigation

pyrig-executables

CI CD ProjectTester

ByteOrderMarkerFormatter CaseConflictChecker DependencyChecker EndOfFileFormatter EndOfLineFormatter JSONFormatter JSONLinter LargeFileChecker MarkdownLinter MergeConflictChecker ModuleTestNamingChecker PythonLinter SecretsChecker SecurityChecker ShellFormatter ShellLinter SpellChecker TOMLLinter TrailingWhitespaceFormatter TypeChecker YAMLLinter

PackageManager Pyrigger RemoteVersionController VersionControlHookManager VersionController

DocsBuilder ExecutableBuilder PackageIndex ProgrammingLanguage License


A pyrig plugin to build executables.


Overview

pyrig-executables is a pyrig plugin that turns your project into standalone executables and attaches one per operating system to every GitHub release — so anyone can run it without installing Python.

What it adds

  • Standalone executables — a single-file binary of your project for Linux, Windows, and macOS, built with PyInstaller.
  • Release integration — a matrix build job that compiles and attaches a binary per OS to each release.
  • Entry point and icon — a main.py and a default icon, both scaffolded and ready to replace with your own.
  • Bundled resources — your project's resources are bundled into the binary.
  • Run commandpyrig-executables run runs your entry point the same way the built binary does, so you can try it locally.
  • Downloads badge — a badge showing the total downloads of your binaries.

Usage

uv add pyrig-executables --dev
uv run pyrig sync

No tokens or secrets are required — the release workflow uses GitHub's automatic token.

Documentation

Full documentation, including the auto-generated API reference, is available on the documentation site.

About

A pyrig plugin to build executables.

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages