Release v0.5.0 (#13)

# Release v0.5.0

## Features 🚀

- Python 3.14 support (Python SDK)
- Installable pre-compiled artifacts (C++ SDK)

## Improvements 🛠️

- Fully implemented compilation firewall using [pImpl](https://en.cppreference.com/w/cpp/language/pimpl.html)  to improve API stability and decouple user code from internal changes (C++ SDK).
- Replaced our build tool [earthly](https://github.com/earthly/earthly) with [Docker bake](https://docs.docker.com/build/bake/) 
- Added build options for disabling the diagram and telemetry features to allow a minimal build (C++ SDK)

## Documentation 📖 

- Integrated C++ docs with main documentation website at https://docs.xronos.com
- Updated and improved C++ and Python API docs
- Show current SDK version

GitOrigin-RevId: 4a0a28fac7401b2f4eb6062e9ff4861789606a2f

---------

Co-authored-by: Christian Menard <christian@xronos.com>
Co-authored-by: Peter Donovan <33707478+petervdonovan@users.noreply.github.com>
Co-authored-by: Copybara Bot <copybara@xronos.com>

Author: 3 people

.clang-tidy

@@ -1,6 +1,5 @@
 Checks: '
     clang-diagnostic-*,
-    boost-*,
     Google-*,
     clang-analyzer-*,
     modernize-*,
@@ -10,13 +9,21 @@ Checks: '
     cppcoreguidelines-*,
     llvm-*,
     cert-*,
-    -clang-analyzer-core.CallAndMessage,
-    -readability-redundant-member-init'
-WarningsAsErrors: true
-HeaderFilterRegex: ''
+    misc-include-cleaner,
+    -readability-redundant-member-init,
+    -portability-template-virtual-member-function'
+WarningsAsErrors: '*'
+HeaderFilterRegex: 'xronos/.*\.hh'
 FormatStyle: none
+UseColor: true
 CheckOptions:
   - key: readability-identifier-length.MinimumParameterNameLength
     value: 2
+  - key: readability-identifier-length.IgnoredVariableNames
+    value: ^(to|it|_)$
+  - key: readability-identifier-length.IgnoredParameterNames
+    value: ^(to|it|_)$
   - key: cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
     value: true
+  - key: misc-include-cleaner.IgnoreHeaders
+    value: bits/chrono.h;pybind11/detail/.*

Dockerfile

@@ -0,0 +1,93 @@
+FROM ubuntu:22.04 AS base
+WORKDIR /xronos
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV DISPLAY=localhost:0.0
+
+ARG clang_tools_version=20
+
+RUN apt-get update -qq
+RUN apt-get install -y -q --no-install-recommends apt-utils
+RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections
+
+# Some base packages required for adding ppas
+RUN apt-get install -y -q --no-install-recommends \
+        ca-certificates \
+        curl \
+        gnupg \
+        gpg \
+        software-properties-common \
+        wget
+
+# add kitware ppa for cmake
+RUN wget -qO- https://apt.kitware.com/keys/kitware-archive-latest.asc | gpg --dearmor - > /usr/share/keyrings/kitware-archive-keyring.gpg
+RUN echo "deb [signed-by=/usr/share/keyrings/kitware-archive-keyring.gpg] https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/kitware.list
+
+# add ppa for clang tools
+RUN wget -qO- https://apt.llvm.org/llvm.sh | bash -s -- ${clang_tools_version}
+
+# add ppa for Python
+RUN gpg --keyserver keyserver.ubuntu.com --recv-keys 6A755776
+RUN gpg --export 6A755776 | gpg --dearmor > /etc/apt/trusted.gpg.d/deadsnakes-ppa.gpg
+RUN echo "deb [signed-by=/etc/apt/trusted.gpg.d/deadsnakes-ppa.gpg] http://ppa.launchpad.net/deadsnakes/ppa/ubuntu $(lsb_release -cs) main" > /etc/apt/sources.list.d/deadsnakes-ppa.list
+
+# install all packages
+RUN apt-get update -qq && apt-get install -y -q --no-install-recommends \
+        build-essential \
+        cmake=3.28.6-0kitware1ubuntu22.04.1 \
+        cmake-data=3.28.6-0kitware1ubuntu22.04.1 \
+        clang-format-${clang_tools_version} \
+        clang-tidy-${clang_tools_version} \
+        dpkg-dev \
+        file \
+        git \
+        global \
+        gnupg \
+        graphviz \
+        llvm-${clang_tools_version}-dev \
+        libclang-${clang_tools_version}-dev \
+        libgl1 \
+        python3.10-dev python3.10-venv \
+        python3.11-dev python3.11-venv \
+        python3.12-dev python3.12-venv \
+        python3.13-dev python3.13-venv python3.13-nogil \
+        python3.14-dev python3.14-venv python3.14-nogil \
+        python3-pygments \
+        zlib1g-dev
+
+# This is a workaround for a gcc bug. See https://gcc.gnu.org/bugzilla/show_bug.cgi?id=118700
+RUN cp /usr/include/python3.13t/pyconfig.h ./
+RUN rm -rf /usr/include/python3.13t
+RUN cp -r /usr/include/python3.13 /usr/include/python3.13t
+RUN rm /usr/include/python3.13t/pyconfig.h
+RUN mv ./pyconfig.h /usr/include/python3.13t/pyconfig.h
+# Same for Python 3.14
+RUN cp /usr/include/python3.14t/pyconfig.h ./
+RUN rm -rf /usr/include/python3.14t
+RUN cp -r /usr/include/python3.14 /usr/include/python3.14t
+RUN rm /usr/include/python3.14t/pyconfig.h
+RUN mv ./pyconfig.h /usr/include/python3.14t/pyconfig.h
+
+RUN update-alternatives --install /usr/bin/clang clang /usr/bin/clang-${clang_tools_version} 100
+RUN update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-${clang_tools_version} 100
+RUN update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-${clang_tools_version} 100
+RUN update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-${clang_tools_version} 100
+
+
+FROM base AS py-venv
+ARG python_version
+COPY dev-requirements.txt ./
+RUN python$python_version -m venv /venv
+RUN . /venv/bin/activate && pip install -r dev-requirements.txt
+# Run pyright once to install its node dependencies
+RUN . /venv/bin/activate && pyright --version
+
+
+FROM scratch AS configs
+COPY .clang-format .clang-tidy dev-requirements.txt pip-build-constraints.txt /
+
+FROM hashicorp/terraform:1.11 AS check-format
+WORKDIR /xronos
+# Need to rename the file because terraform fmt errors out for .hcl (without tftest)
+COPY docker-bake.hcl docker-bake.tftest.hcl
+RUN terraform fmt --check docker-bake.tftest.hcl

Earthfile

@@ -1,5 +1,11 @@
 # Xronos
 
+[![GitHub Release](https://img.shields.io/github/v/release/xronos-inc/xronos?logo=GitHub)](https://github.com/xronos-inc/xronos/releases/latest)
+[![PyPI - Version](https://img.shields.io/pypi/v/xronos?logo=Python&logoColor=silver)](https://pypi.org/project/xronos/)
+[![GitHub License](https://img.shields.io/github/license/xronos-inc/xronos)](https://github.com/xronos-inc/xronos/blob/main/LICENSE)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xronos?logo=Python&logoColor=silver)](https://pypi.org/project/xronos/)
+[![Static Badge](https://img.shields.io/badge/docs-blue?logo=Read%20the%20Docs&logoColor=white)](https://docs.xronos.com/)
+
 **Xronos** is a lightweight framework for building deterministic, component-based robotics applications in Python or C++.
 It supports real-time telemetry, system visualization, and modular design with a focus on clarity, scalability, and correctness.
 
@@ -14,43 +20,38 @@ It supports real-time telemetry, system visualization, and modular design with a
 
 ## Usage
 
-For Python users, the [xronos PyPi package](https://pypi.org/project/xronos/) is published as a standalone Python
-package. Building from source is not required.
-
-- **Python users**: Get started at [docs.xronos.com](https://docs.xronos.com)
-- **C++ users**: See [docs.xronos.com/cpp](https://docs.xronos.com/cpp)
-- **VS Code users**: The [Xronos VS Code Extension](https://marketplace.visualstudio.com/items?itemName=xronos.xronos) is optional and enables diagrams of your programs
+- **Python users**: See [docs.xronos.com/python\_sdk/getting\_started.html](https://docs.xronos.com/python_sdk/getting_started.html)
+- **C++ users**: See [docs.xronos.com/cpp\_sdk/getting\_started.html](https://docs.xronos.com/cpp_sdk/getting_started.html)
+- **VS Code users**: The optional [Xronos VS Code Extension](https://marketplace.visualstudio.com/items?itemName=xronos.xronos) renders diagrams of your programs
 
 ## Repository Structure
 
 ```bash
 .
-├── base-images/:   # Earthly base images
-├── cpp-sdk/:       # C++ SDK
+├── cpp-sdk/        # C++ SDK
+├── docker-bake.hcl # build definitions
 ├── docs/           # source for https://docs.xronos.com
-├── examples/:      # python SDK examples
-├── lib/            # library components
+├── examples/       # python SDK examples
+├── lib/            # core Xronos libraries
 ├── third-party/    # third-party libraries
-├── xronos/         # source for the xronos framework
-├── Earthfile       # earthly build definitions
+├── xronos/         # Python SDK
 └── README.md       # project overview (this file)
 ```
 
 ## Building from Source
 
-To build locally:
 
-1. [Install Docker](https://docker.com)
-2. [Install Earthly](https://earthly.dev/get-earthly)
-3. Run:
+We use [docker bake](https://docs.docker.com/build/bake/) as our top-level build
+tool. To build locally, install [docker](https://docker.com) and the [buildx
+extension](https://github.com/docker/buildx) (if not included in your docker
+installation). Then run:
 
-   ```bash
-   earthly +build
-   ```
+```bash
+docker buildx bake build
+```
 
 ## Links
 
-- Website: [https://xronos.com](https://xronos.com)  
-- Python Package: [https://pypi.org/project/xronos](https://pypi.org/project/xronos/)  
-- Documentation: [https://docs.xronos.com](https://docs.xronos.com)  
-- C++ Docs: [https://docs.xronos.com/cpp](https://docs.xronos.com/cpp)
+- Documentation: [https://docs.xronos.com](https://docs.xronos.com)
+- Company website: [https://xronos.com](https://xronos.com)
+- Python package: [https://pypi.org/project/xronos](https://pypi.org/project/xronos/)

README.md

@@ -1 +1,2 @@
 doxygen/
+pkgs/