Skip to main content

A generic fast cross-compilation tool using Docker and Sysroots

Project description

cross-compile-tool

A blazing fast, generic cross-compilation utility for C++ and ROS 2. It uses Docker to generate an ARM64 sysroot and standard native tools (GCC/Ninja) for compilation.

Prerequisites

  • Docker: For building the sysroot & dev environments.
  • Cross Compiler: sudo apt install g++-aarch64-linux-gnu (Only required for Host builds).

Installation

# Recommended: Install in a virtual environment
pip install .

Usage

The tool uses subcommands: init, status, prep (or sysroot), build, clean, build-dev, and run-dev.

1. Initialize (New Project)

Create a template apt_packages.txt for your dependencies.

cct init

2. Status check

Check the current environment and sysroot staleness.

cct status

3. Build (The Daily Driver)

Compiles your code. It automatically prepares the sysroot if it's missing.

# Basic usage (compiles current directory)
cct build

# Clean build
cct build --clean

# ROS 2 Specific: Build only selected packages
cct build --packages-select my_pkg1 my_pkg2

Common Options:

  • --packages-select: Build specific packages only (colcon only).
  • --packages-up-to: Build specified packages and their dependencies (colcon only).
  • --packages-ignore: Skip specific packages during the build.
  • --clean: Wipe build directory before compiling.
  • --build-tool [colcon|cmake]: Force a specific tool (default: auto).

4. Docker-based Development

For a reproducible environment without installing cross-compilers on your host:

  1. Prepare Sysroot: Run cct prep on your Host system to sync the target libraries.
  2. Build Dev Image: Run cct build-dev to create the cross-compilation container.
  3. Enter Environment: Run cct run-dev to start and enter the container.
  4. Compile: Run cct build inside the container to compile your project.

Note: Your project directory and sysroot are automatically mounted into the container.


🛠 Advanced Features

  • Status Check: cct status to verify environment and sysroot staleness.
  • Selective Build: cct build --packages-select pkg1 (colcon only).
  • Environment Variables: Use CCT_BASE_IMAGE or CCT_SYSROOT to skip flags.
  • CI/CD: Run cct prep on the runner host, then mount sysroot_arm64 into your build.

🧹 Cleanup

cct clean          # Remove build/install artifacts
cct clean --all    # Also wipe the sysroot

Project details


Download files

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

Source Distribution

cross_compile_tool-0.1.4.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

cross_compile_tool-0.1.4-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file cross_compile_tool-0.1.4.tar.gz.

File metadata

  • Download URL: cross_compile_tool-0.1.4.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cross_compile_tool-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ada10aa11bef82e9dd3ab28d1c353d86ecc3f175a646ff335720d745e3cb7417
MD5 17e0319e404d7393aebc4cea0882c41e
BLAKE2b-256 633a8f217beec0f393c8e14544a5ab94e3d32b7a2548c6a24f528a84818c6d91

See more details on using hashes here.

Provenance

The following attestation bundles were made for cross_compile_tool-0.1.4.tar.gz:

Publisher: pypi-publish.yml on Benjamin-Tan/cross-compile-tool

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

File details

Details for the file cross_compile_tool-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for cross_compile_tool-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 48e9c1fee38f29f759c3695e54aeb15a0aed159f2660874198e4bec8099eba83
MD5 27569df13b427831def8a08b287dd107
BLAKE2b-256 1c5447379b7f0f168ef03ca9800766cb16e2d747d7f31ac8bffa378fe2a0a080

See more details on using hashes here.

Provenance

The following attestation bundles were made for cross_compile_tool-0.1.4-py3-none-any.whl:

Publisher: pypi-publish.yml on Benjamin-Tan/cross-compile-tool

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page