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.5.tar.gz (14.1 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.5-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cross_compile_tool-0.1.5.tar.gz
  • Upload date:
  • Size: 14.1 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.5.tar.gz
Algorithm Hash digest
SHA256 67e324d4eb6119f8d5d88b535a656277a7abcab928c536eae7fd2c28b6f0b829
MD5 4151dc7003fe67bceb8d9087fd7484c1
BLAKE2b-256 bccfe768a51e93cd3603b52b21065d2df016d52a8f2087e02660352215dfa8bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for cross_compile_tool-0.1.5.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.5-py3-none-any.whl.

File metadata

File hashes

Hashes for cross_compile_tool-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b3626cfd01ea65324627cb75da313b32d39b4a5631611736bb2da79972fb0254
MD5 eaf3785801a92591ff6757f171161e41
BLAKE2b-256 8f2d5f0e18c078c8cee53c8266746011a654ec9d04bce680e6626f330507f2c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for cross_compile_tool-0.1.5-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