Skip to content
astrapatchastrapatch

Getting Started

Installation

astrapatch is a Python package with no runtime dependencies.

Pre-alpha. The framework repository is currently private. Request contributor access to get it. There is no package on PyPI yet.

Requirements

  • Python 3.11 or newer
  • git
  • make and a C compiler (gcc or clang), only for the demo spacecraft and the end-to-end tests
  • cppcheck (optional). Its adapter is skipped when it is not installed.

On Ubuntu or Debian:

sudo apt install python3 python3-venv build-essential git

On macOS, run xcode-select --install and install Python from python.org or with Homebrew. On Windows, use WSL with Ubuntu.

Install

git clone https://github.com/astrapatch/astrapatch.git
cd astrapatch
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
astrapatch --version

Check the installation

pytest

Every test should pass. Tests that need a compiler are skipped cleanly when none is installed.

Next

Continue with the Quickstart.