Installation
From PyPI (Recommended)
Section titled “From PyPI (Recommended)”AegisQ is published on PyPI with pre-built wheels:
uv add aegisq-pqcpip install aegisq-pqcRequirements:
- Python ≥ 3.11
- No Rust toolchain needed when a wheel is available for your platform; otherwise installation builds from source
AegisQ targets PyO3’s abi3-py311 stable ABI. Wheels are still OS/architecture-specific; ABI compatibility does not establish testing on every future Python version or free-threaded build.
From Source (requires Rust toolchain)
Section titled “From Source (requires Rust toolchain)”If you want to build from source (e.g., for development or auditing), follow either workflow below. uv sync --dev may refresh uv.lock to match the checkout; --locked is only appropriate when the lockfile is already synchronized with the project version and dependencies.
# Clone and buildgit clone https://github.com/AC-Santiago/AegisQ.gitcd AegisQ
uv sync --dev
uv run maturin develop --release# Clone and buildgit clone https://github.com/AC-Santiago/AegisQ.gitcd AegisQ
python -m venv .venvsource .venv/bin/activate # Windows PowerShell: .venv\Scripts\Activate.ps1python -m pip install maturin
maturin develop --releaseDevelopment Build (debug, faster compilation)
Section titled “Development Build (debug, faster compilation)”For development and testing, you can use a debug build which compiles faster:
uv run maturin developSystem Requirements
Section titled “System Requirements”| Requirement | Version |
|---|---|
| Python | ≥ 3.11 |
| Rust (source build only) | Latest stable via rustup |
| OS | Linux, macOS, Windows |