Documentation
Technical documentation for installing, configuring, and running the Pyvorin compiler.
What Pyvorin Is
Pyvorin is a Python-to-native compiler and runtime platform. It analyses standard Python code and attempts to produce native executables for supported workloads. When native compilation is not possible, Pyvorin falls back to a standard CPython interpreter so your program continues to run. Pyvorin is not a drop-in replacement for every Python runtime. It works best for self-contained scripts and packages that use the standard library or supported third-party wheels, have a clear entry point, and avoid runtime code generation such as exec or eval. Supported workloadsStandard library or supported third-party wheels.Stable types and clear control flow.A defined entry point such as app.py or a configured pyproject.toml/pyvorin.toml. Current limitationsNot every Python program can be compiled to native code. Unsupported constructs are recorded as fallback reasons and executed through CPython. Performance gains depend on the workload; some programs see large improvements, others see little or none. The CLI, licence system, and telemetry are production-ready. Edge runtime features are available through a separate SDK and runtime package.
Updated 1 month ago
Installation
RequirementsPython 3.10, 3.11, or 3.12 installed as python or python3.A working internet connection for licence activation and telemetry.Linux (glibc), macOS 12+, or Windows 10/11 on x86_64 or ARM64. Install from PyPIpip install pyvorinWe recommend installing inside a virtual environment:python -m venv .venv source .venv/bin/activate # Windows: .venv\Scripts\activate pip install pyvorin Verify the installpyvorin --version pyvorin doctorpyvorin doctor checks your Python version, platform support, network reachability, and licence daemon status. It does not transmit source code. Platform notesMost glibc-based Linux distributions are supported. musl-based distributions such as Alpine Linux may work but are not fully supported. macOS 12 and later work on Intel and Apple Silicon without Rosetta. Windows 10 version 2004 and later, and Windows 11, are supported. Uninstallpip uninstall pyvorin
Updated 1 month ago
Authentication
Pyvorin uses the Pyvorin Portal to authenticate devices and licence keys. The CLI supports web-based device activation and licence-key activation. Device activation flowRun pyvorin auth login.The CLI displays a device code and a URL such as https://crm.pyvorin.com/device.Open the URL, sign in to your Pyvorin account, and enter the code.The CLI polls until you approve the request.Once approved, the CLI stores a device token locally. Licence-key activationRun pyvorin auth activate --key PYV-XXXX-XXXX-XXXX.The CLI sends your device token and licence key to the Portal.The server returns a long-lived licence device token if the key is valid and within its device limit. Token expiry and refreshDevice authorization codes expire after 10 minutes. Licence device tokens can be refreshed with pyvorin auth refresh. If a token expires or is revoked, the CLI requests re-authentication. RevocationYou can revoke a device from the Licences page in the Portal. Once revoked, the device token is invalid and the CLI must re-authenticate. Revocation takes effect immediately for new requests.
Updated 1 month ago
First Compile
After installing Pyvorin and activating your licence, you can compile a Python file. Basic compilepyvorin compile app.pyPyvorin analyses app.py, attempts native compilation, and writes output to the build directory configured in pyvorin.toml (default ./build). What happens during compilationThe CLI validates your licence and device token.Pyvorin parses and type-infers your code.Supported modules are compiled to native code.Unsupported constructs are marked for fallback and executed by CPython at runtime.Compile metrics are sent to the Portal. Viewing resultspyvorin compile app.py --reportThe report shows native coverage percentage, fallback reasons, compile duration, and credits used. Successful compiles deduct 1 credit; error compiles do not. Run the output./build/appIf the build fell back entirely to CPython, the output script runs as normal Python.
Updated 1 month ago
Quickstart Guide
This guide walks you from account creation to your first native compile. Create a Pyvorin account at crm.pyvorin.com/register.Install the CLI with pip install pyvorin.Activate your licence key from the Licence Keys page.Run pyvorin compile app.py --report inside your project.Review the report and run the output binary. For help at any step, run pyvorin doctor or open a support ticket from the Portal.
Updated 1 month ago
Creating an Account
You need a Pyvorin account to manage licences, billing, support tickets, and API tokens. Sign upVisit crm.pyvorin.com/register, enter your email, name, and password, then confirm your email address. You can also sign up through an organisation invitation. After registrationOnce signed in, you can add a billing address, view your subscription, create licence keys, and generate API tokens. Two-factor authentication can be enabled from the Security page.
Updated 1 month ago
Portal Overview
The Pyvorin Portal is the customer-facing dashboard for managing your account, licences, billing, and support. Main sectionsDashboard — usage summary, recent compiles, and credit balance.Licences — licence keys and active devices.Billing — invoices, payment methods, and subscription.Support — support tickets and responses.API Tokens — personal access tokens for the Customer API. Most actions can be performed without contacting support. Use the search bar or documentation links to find help.
Updated 1 month ago
System Requirements
Pyvorin runs on modern x86_64 and ARM64 systems. Before installing, confirm your environment meets the minimum requirements. RequiredPython 3.10, 3.11, or 3.12.Linux (glibc), macOS 12+, or Windows 10/11.At least 2 GB of free RAM for small projects; larger projects need more.An internet connection for activation and telemetry. Not supportedmusl-only Linux, 32-bit operating systems, and Windows versions older than Windows 10 version 2004 are not supported. Running inside a supported container on an unsupported host may also fail.
Updated 1 month ago
Supported Platforms
Pyvorin supports the following platforms for the CLI and native compilation. Linux x86_64 and ARM64 (glibc-based distributions).macOS 12+ on Intel and Apple Silicon.Windows 10/11 x86_64 and ARM64. Platform support may expand over time. The output of pyvorin doctor shows whether your current system is supported.
Updated 1 month ago
Choosing a Plan
Pyvorin plans differ in compile credits, device limits, support level, and optional Edge entitlement. Review the Subscription page in the Portal to compare current plans. Consider your expected compile volume, team size, and whether you need priority support or Edge access. You can upgrade or downgrade from the same page. Changes typically take effect immediately or at the next billing cycle, depending on the provider.
Updated 1 month ago