PyCrucible

PyCrucible

PyCrucible is a powerful and robust cross-platform builder and launcher designed specifically for Python applications utilizing the UV binary. Built with Rust, it simplifies the deployment process of Python apps by packaging them into a single self-contained executable, eliminating the need for a separate Python installation.

Overview

This tool executes Python applications within an ephemeral environment using the UV binary. By extracting your application and reading configurations from either pycrucible.toml or pyproject.toml, PyCrucible ensures a seamless deployment process. With PyCrucible, running a Python application is as straightforward as executing a single binary, making it an ideal solution for developers seeking ease of distribution across machines.

Key Features

• Cross-Platform Compatibility: Supports Windows, macOS (in testing), and Linux.
• Lightweight Binary: The runner binary is only 2 MB, making it efficient in terms of size, even as it grows with the embedded project.
• Configurable Options: Customize embedding details through pycrucible.toml or pyproject.toml, including entry points, file inclusion/exclusion patterns, environment variables, and more.
• Automatic Updates: Configure your project to check for updates from a specified GitHub repository before execution.
• Versatile Requirements Support: Compatibility with various requirement definitions, including pyproject.toml, requirements.txt, and more.
• Built-in Testing: Comprehensive unit tests ensure reliability and performance.

Quick Start

To get started with PyCrucible, simply have a main.py file ready. Install PyCrucible using Python's package manager:

pip install pycrucible

To create an embedded binary from your project, execute:

pycrucible -e .

This will generate a binary named launcher (or launcher.exe on Windows) that can be distributed independently of a Python installation.

Configuration

Configuration is easily managed through:

• pycrucible.toml
• pyproject.toml

Both files allow defining essential parameters such as the entry point and environment variables. Example configurations are provided within the repository.

Documentation

For detailed documentation, please visit the PyCrucible docs.

Conclusion

Designed to streamline the deployment of Python applications, PyCrucible enhances flexibility and usability within the development lifecycle. Explore the functionality and features of PyCrucible to simplify your Python app deployment today.