🚀 Quick Start
whl-deploy simplifies Apollo deployment into two streamlined phases: Packaging (creating a portable release) and Deploying (setting up the host).
1. One-Step Deployment (Run/Install)
This is the standard scenario for end-users. Using a generated release bundle (e.g., wheelos_1.0.0_ubuntu22.04_x86_64_nvidia.tar), you can restore the entire environment—including source code, Docker images, and data—with a single command.
The tool automates the following workflow:
- 📦 Unpack: Extracts the bundle to the workspace.
- 📖 Configure: Loads the internal
manifest.yaml. - 🚀 Deploy: Installs artifacts (Source, Docker, Maps, Models).
- ⚙️ Post-Run: Executes setup scripts (e.g., GPU checks).
# Standard installation from a release bundle
whl-deploy run --bundle wheelos_1.0.0_ubuntu22.04_x86_64_nvidia.tar
# Using aliases (Short syntax)
whl-deploy r -b wheelos_1.0.0_ubuntu22.04_x86_64_nvidia.tar
💡 Tip: Development Mode If you are working in a development environment where the code is already present (git cloned) and you don't have a tarball, you can run deployment directly using the local manifest:
whl-deploy run --manifest whl_deploy/manifest.yaml
2. Creating a Release (Pack)
For developers or CI/CD pipelines, whl-deploy consolidates all resources defined in your manifest.yaml into a single, distributable file.
Key Features:
- Auto-Naming: Automatically generates names like
{project}_{ver}_{os}_{arch}_{gpu}.tar. - Smart Packing: Fetches remote resources and standardizes directory structures.
- No-Double-Compression: Uses uncompressed tar for the outer shell to speed up deployment.
# Pack using a specific manifest file
whl-deploy pack --manifest whl_deploy/manifest.yaml
# Using aliases
whl-deploy p -m whl_deploy/manifest.yaml
3. Configuration (Manifest)
whl-deploy adopts a "Configuration as Code" approach. The manifest.yaml defines what to pack (inputs) and where to deploy it (outputs).
📄 View the Example Manifest: 👉 whl_deploy/manifest.yaml
4. Command Reference
Global Options
These flags apply to all commands:
-m, --manifest <path>: Specify a custom manifest file path (Default:./manifest.yaml).-v, --verbose: Enable detailed debug logging.
Subcommands
| Command | Alias | Description | Key Flags |
|---|---|---|---|
run |
r, install, i |
Deploy artifacts to the host system. | -b, --bundle <path>: Path to the .tar file to unpack. |
pack |
p |
Create a consolidated release package. | N/A (Uses manifest settings) |
🤝 Contribution & Support
whl-deploy aims to standardize the complex deployment of autonomous driving software. If you have questions, suggestions, or wish to contribute:
- 🐛 Report Bugs: Submit an Issue.
- 🛠️ Contribute: Fork the repo and create a Pull Request.
Metadata
Release files for whl-deploy 0.0.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| whl_deploy-0.0.7.tar.gz | 34.6 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| whl_deploy-0.0.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 86.6 kB
Release files / whl_deploy-0.0.7.tar.gz
| Download URL | whl_deploy-0.0.7.tar.gz |
|---|---|
| Size | 34.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
360fa2de45ba490f7992412b8fe0a48c2fe4ade357ca0b931c27b44b0617b421
|
|
BLAKE2b-256 checksum How to use checksums |
c3283c2be35f2d1036a6070215ae6ca36624e2f1de57154bd7efb1264891cce6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 18, 2026.
Transparency logRelease files / whl_deploy-0.0.7-py3-none-any.whl
| Download URL | whl_deploy-0.0.7-py3-none-any.whl |
|---|---|
| Size | 52.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ca0fa4d48f4755f27002f4b4324c0df71b543b8409e5b8b5f2d55dda67467b6d
|
|
BLAKE2b-256 checksum How to use checksums |
2606042b3f559a46ad36b8db30871a9dcf88d5693fb9cbb97e65ff6f6c653cd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 18, 2026.
Transparency logSecurity for whl-deploy 0.0.7
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for whl_deploy-0.0.7.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 18, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.