Documentation
Technical documentation for installing, configuring, and running the Pyvorin compiler.
Installing with pip
The recommended way to install Pyvorin is through pip from PyPI. pip install pyvorinFor a clean environment, create a virtual environment first:python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activate pip install pyvorin If you use pipx, you can run pipx install pyvorin to install the CLI in an isolated environment.
Updated 1 month ago
Virtual Environments
Virtual environments isolate Pyvorin and your project dependencies from system packages. python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activate pip install pyvorin Always activate the same environment before compiling. Dependencies must be installed in that environment so Pyvorin can analyse them.
Updated 1 month ago
Verifying Installation
After installation, verify that the CLI is available and your platform is supported. pyvorin --version pyvorin doctor pyvorin doctor prints a report covering Python version, platform, network reachability, and licence daemon status. Fix any reported failures before compiling.
Updated 1 month ago
Upgrading Pyvorin
Keep Pyvorin up to date to receive compiler improvements, bug fixes, and new platform support. pip install --upgrade pyvorin After upgrading, run pyvorin doctor and re-authenticate if prompted. Review the release notes for breaking changes to configuration keys.
Updated 1 month ago
Uninstalling Pyvorin
To remove Pyvorin from your environment, run: pip uninstall pyvorin Device tokens stored in the Pyvorin configuration directory are not automatically removed. You can delete the configuration directory or revoke the device from the Portal.
Updated 1 month ago
Docker Installation
You can run Pyvorin inside a Docker container as long as the base image uses a supported platform. Use an official Python image based on a glibc distribution, such as python:3.11-bookworm. Install Pyvorin inside the container, activate your licence, and run compiles as usual. Remember that device tokens are stored inside the container by default. For CI/CD, consider using a volume or secret mount for tokens.
Updated 1 month ago
CI/CD Installation
Pyvorin can be installed in CI/CD pipelines for automated builds. pip install pyvorin pyvorin auth activate --key $PYVORIN_LICENCE_KEY pyvorin compile app.py Store your licence key as a protected secret. Use a dedicated licence key with a device limit that matches the number of concurrent runners. Revoke CI devices periodically if they are ephemeral.
Updated 1 month ago
Offline Install Notes
Pyvorin requires periodic internet access for licence verification and telemetry. Fully offline operation is not supported. You can install Pyvorin from a downloaded wheel using pip install /path/to/pyvorin.whl, but the first activation and subsequent check-ins still require network connectivity.
Updated 1 month ago