Skip to main content

🚀 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:

  1. 📦 Unpack: Extracts the bundle to the workspace.
  2. 📖 Configure: Loads the internal manifest.yaml.
  3. 🚀 Deploy: Installs artifacts (Source, Docker, Maps, Models).
  4. ⚙️ 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

whl_deploy-0.0.7.tar.gz (34.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

whl_deploy-0.0.7-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

Details for the file whl_deploy-0.0.7.tar.gz.

File metadata

  • Download URL: whl_deploy-0.0.7.tar.gz
  • Upload date:
  • Size: 34.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for whl_deploy-0.0.7.tar.gz
Algorithm Hash digest
SHA256 360fa2de45ba490f7992412b8fe0a48c2fe4ade357ca0b931c27b44b0617b421
MD5 8c892174fd291daaca99a7aafe0bb7c5
BLAKE2b-256 c3283c2be35f2d1036a6070215ae6ca36624e2f1de57154bd7efb1264891cce6

See more details on using hashes here.

Provenance

The following attestation bundles were made for whl_deploy-0.0.7.tar.gz:

Publisher: python-publish.yaml on wheelos-tools/whl-deploy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file whl_deploy-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: whl_deploy-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 52.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for whl_deploy-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ca0fa4d48f4755f27002f4b4324c0df71b543b8409e5b8b5f2d55dda67467b6d
MD5 6ffe5f9b58446fc2403ce04da5ced3bc
BLAKE2b-256 2606042b3f559a46ad36b8db30871a9dcf88d5693fb9cbb97e65ff6f6c653cd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for whl_deploy-0.0.7-py3-none-any.whl:

Publisher: python-publish.yaml on wheelos-tools/whl-deploy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.0.7 This release

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page