Skip to content

Installation

Gitronics is distributed as a Python package containing a compiled Rust extension. Pre-built wheels are published to PyPI for the most common platforms; no Rust toolchain is required for end users.

Requirements

  • Python 3.9 or later
  • A supported platform: Linux x86_64 / aarch64, macOS x86_64 / Apple Silicon, Windows x86_64

Install from PyPI

pip install gitronics

After installation the gitronics command is available in your shell:

gitronics --help

Note

Some corporate computers do not allow the execution of non-whitelisted executable files. If when running gitronics you get an error like Access denied, you could try running the command as a Python module instead: 

python -m gitronics --help

Install from source

Building from source requires:

git clone https://github.com/Fusion4Energy/gitronics
cd gitronics
pip install maturin
maturin develop --release

Building the documentation locally

pip install -r docs/requirements.txt
mkdocs serve

Open http://127.0.0.1:8000 in your browser.