Installation

PyTECGg features a performance-critical core written in Rust and a high-level API in Python. Pre-compiled binaries (wheels) for most common platforms are provided.

📦 From PyPI (recommended)

For most users, the simplest way is to install the pre-built package from PyPI:

pip install pytecgg

This will also install all required Python dependencies automatically.

🛠️ From source distribution

If you want to compile the package from source (e.g., to benefit from specific CPU optimizations or for inspection), you can force pip to use the source distribution:

pip install pytecgg --no-binary :all:

Note

Building from source requires a working Rust toolchain (rustc, cargo). You can install it via rustup.rs.

👩🏻‍💻 For development

If you want to contribute to the project or modify the source code, a development installation with maturin is recommended.

1. Prerequisites

   Make sure you have a working Rust toolchain, or get it via rustup.rs.

2. Clone the repository

   git clone https://github.com/viventriglia/PyTECGg.git
   cd PyTECGg
   

3. Install and build

   maturin develop
   

   maturin will compile the Rust core and link it to your environment. Any Python change will be reflected immediately, while Rust changes will require re-running maturin develop to recompile the binary.