HPM Documentation
HPM (Houdini Package Manager) is a Rust-based package manager for SideFX
Houdini. It manages both Houdini packages and their Python dependencies,
produces reproducible installs with a lock file and SHA-256 checksums, and
generates the package.json files Houdini needs to load packages at launch.
User documentation
- User guide — install, commands, the
hpm.tomlmanifest, global configuration, troubleshooting. - Python dependencies —
[python_dependencies], Houdini-to-Python version mapping, venv sharing, cleanup. - Registries — configuring API and Git registries, per-user vs per-project, search and caching.
- Security — checksums, package signing,
hpm audit, threat model.
Contributor documentation
- Architecture — system design, dependency resolution, cleanup, Python integration.
- API overview — crate structure and key public types. Full rustdoc via
cargo doc. - Testing guide — property-based testing strategy.
- CONTRIBUTING.md — development setup, workflow, pull request guidelines.
Where these docs are published
This directory is the single source for two sites:
- hpm.readthedocs.io builds it with mdBook
(
book.toml,.readthedocs.yaml), driven bySUMMARY.md. - docs.tumbletrove.com/hpm/ pulls it in
via the
tumbletrove-docsassembler, driven bymanifest.toml.
Adding or renaming a page means updating both SUMMARY.md and
manifest.toml, or it will go missing from one of the two sites.