Contributing to PyOxidizer¶
This page documents how to contribute to PyOxidizer.
As a User¶
PyOxidizer is currently a relative young project and could substantially benefit from reports from its users.
Try to package applications with PyOxidizer. If things break or are hard to learn, file an issue on GitHub.
You can also join the pyoxidizer-users mailing list to report your experience, get in touch with other users, etc.
As a Developer¶
If you would like to contribute to the code behind PyOxidizer, you can do so using a standard GitHub workflow through the canonical project home at https://github.com/indygreg/PyOxidizer.
Please note that PyOxidizer’s maintainer can be quite busy from time to time. So please be patient. He will be patient with you.
The documentation around how to hack on the PyOxidizer codebase is a bit lacking. Sorry for that!
The most important command for contributors to know how to run is
cargo run --bin pyoxidizer. This will compile the
program and run it. Use it like
cargo run --bin pyoxidizer -- init
~/tmp/myapp to run
pyoxidizer init ~/tmp/myapp for example.
Cargo.toml in the root of the repository defines a Cargo workspace
containing many crates.
Some crates have build/link dependencies against a Python interpreter. If you
run into build errors, try targeting just the crate you care about by adding
-p argument. e.g.
cargo build -p pyoxidizer. Or exclude troublesome
cargo build --workspace --exclude python-oxidized-importer
Financial contributions of any amount are appreciated. Please do not feel obligated to donate money: only donate if you are financially able and feel the maintainer deserves the reward for a job well done.