Important

This repository has moved. styxpodman (the Podman runner) is now developed in the styx-runtime-py monorepo, alongside the other Styx Python runtime packages. New issues and pull requests should be filed there. The PyPI package styxpodman continues to be published from the new location.

---

Podman Runner for Styx compiled wrappers

styxpodman is a Python package that provides Podman integration for Styx compiled wrappers. It allows you to run Styx functions within Podman containers, offering improved isolation and reproducibility for your workflows.

Installation

You can install styxpodman using pip:

pip install styxpodman

Usage

from styxdefs import set_global_runner
from styxpodman import PodmanRunner

# Initialize the PodmanRunner
runner = PodmanRunner()

# Set the global runner for Styx
set_global_runner(runner)

# Now you can use any Styx functions as usual, and they will run in Podman containers

Advanced Configuration

The PodmanRunner class accepts several parameters for advanced configuration:

• image_overrides: A dictionary to override container image tags
• podman_executable: Path to the Podman executable (default: "podman")
• data_dir: Directory for temporary data storage
• environ: Environment variables to set in the container

Example:

runner = PodmanRunner(
    image_overrides={"python:3.9": "my-custom-python:3.9"},
    podman_executable="/usr/local/bin/podman",
    data_dir="/tmp/styx_data",
    environ={"PYTHONPATH": "/app/lib"}
)

Error Handling

styxpodman provides a custom error class, StyxPodmanError, which is raised when a Podman execution fails. This error includes details about the return code, command arguments, and Podman arguments for easier debugging.

Contributing

Contributions to styxpodman are welcome! Please refer to the GitHub repository for information on how to contribute, report issues, or submit pull requests.

License

styxpodman is released under the MIT License. See the LICENSE file for details.

Documentation

For detailed API documentation, please visit our API Docs.

Support

If you encounter any issues or have questions, please open an issue on the GitHub repository.

Requirements

• Python 3.10+
• Podman installed and running on your system

Comparison with styxdocker

While styxdocker and styxpodman serve similar purposes, they have some key differences:

• Container Technology: styxdocker uses Docker, while styxpodman uses Podman.

Choose the package that best fits your infrastructure and requirements.