Hey! These docs are for version 2.10, which is no longer officially supported. Click here for the latest version, 2.13!

pyoxidizer

The PyOxidizer utility for packaging Python code in a Rust binary (https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer.html).

Used with the pyoxidizer_binary target.

Backend: pants.backend.experimental.python.packaging.pyoxidizer
Config section: [pyoxidizer]

Basic options

args

--pyoxidizer-args="[<shell_str>, <shell_str>, ...]"
PANTS_PYOXIDIZER_ARGS
default: []

Arguments to pass directly to PyOxidizer, e.g. --pyoxidizer-args="--release"


Advanced options

version

--pyoxidizer-version=<str>
PANTS_PYOXIDIZER_VERSION
default: pyoxidizer==0.18.0

Requirement string for the tool.


extra_requirements

--pyoxidizer-extra-requirements="['<str>', '<str>', ...]"
PANTS_PYOXIDIZER_EXTRA_REQUIREMENTS
default: []

Any additional requirement strings to use with the tool. This is useful if the tool allows you to install plugins or if you need to constrain a dependency to a certain version.


interpreter_constraints

--pyoxidizer-interpreter-constraints="['<str>', '<str>', ...]"
PANTS_PYOXIDIZER_INTERPRETER_CONSTRAINTS
default:
[
  "CPython>=3.8"
]

Python interpreter constraints for this tool.


console_script

--pyoxidizer-console-script=<str>
PANTS_PYOXIDIZER_CONSOLE_SCRIPT
default: pyoxidizer

The console script for the tool. Using this option is generally preferable to (and mutually exclusive with) specifying an --entry-point since console script names have a higher expectation of staying stable across releases of the tool. Usually, you will not want to change this from the default.


entry_point

--pyoxidizer-entry-point=<str>
PANTS_PYOXIDIZER_ENTRY_POINT
default: None

The entry point for the tool. Generally you only want to use this option if the tool does not offer a --console-script (which this option is mutually exclusive with). Usually, you will not want to change this from the default.


Deprecated options

None


Did this page help you?