Documentation
Technical documentation for installing, configuring, and running the Pyvorin compiler.
Redaction
Pyvorin redacts sensitive information before sending telemetry. Source code is not uploaded by default.Command text is hashed unless you explicitly opt in.MAC addresses are hashed.IP addresses are stored with retention limits. You can disable command redaction in pyvorin.toml, but this is not recommended for production environments.
Updated 1 month ago
Managing Your Account
Your Pyvorin account gives you access to the Portal dashboard, licence management, billing history, and support tickets. Signing inVisit crm.pyvorin.com/login and enter your email and password. Two-factor authentication can be enabled from the security settings. Updating your profileFrom the customer dashboard, go to Profile to update your name, theme preference, and billing address. Deleting your accountAccount deletion is available from the Security page. This removes personal data subject to retention policies and may cancel active subscriptions.
Updated 1 month ago
Updating Your Profile
You can update personal information from the Profile page in the Portal. Changes typically include your display name, company, billing address, and theme preference. Billing address updates may take a few minutes to propagate to invoices. If you cannot save changes, ensure all required fields are filled and try again. Contact support if the issue persists.
Updated 1 month ago
Organisations
Organisations let multiple users share billing and licences under one account. RolesOwner — full control over billing, licences, and members.Admin — can manage licences and invite members.Member — can use licences and view shared resources. Organisation owners and admins can invite members by email. Invited users receive a link to join and can switch between personal and organisation contexts.
Updated 1 month ago
Viewing Invoices
Pyvorin subscriptions are billed through Stripe or Paddle, depending on your region and plan. Go to Billing in the Portal to see invoices, payment status, and line items. You can download PDFs for paid and open invoices. Failed payments are highlighted on the billing page. Open invoices can be paid manually or through a signed public payment link.
Updated 1 month ago
Payment Methods
Update cards or direct debit details through the billing provider portal linked from the Billing page. Payment method changes are handled by Stripe or Paddle for security. Pyvorin does not store full card numbers. If a payment method fails, update it promptly to avoid service interruption.
Updated 1 month ago
Licence Overview
Licence keys control how many devices can run the Pyvorin CLI under your subscription. Finding your licence keyVisit Licence Keys in the Portal. Keys are masked by default; use the reveal action to see the full key when activating a new device. Device limitsEach licence key has a device limit set by your plan. You can see active devices and revoke unused ones from the licence detail page.
Updated 1 month ago
Creating Licence Keys
Depending on your plan, you can create additional licence keys for different teams or environments. Go to Licence Keys.Click Create Key.Choose a label and optional device limit.Copy the plaintext key and store it securely. Each key can be revoked or rotated independently. Use separate keys for development, CI, and production to limit blast radius.
Updated 1 month ago
Device Limits
Device limits control how many machines can activate a single licence key. If you reach the limit, new activations fail until you revoke an existing device or upgrade to a plan with a higher limit. Active devices are listed on the licence detail page. CI runners and ephemeral containers should use a dedicated key and revoke devices after use if possible.
Updated 1 month ago
Activating Devices
Activate a device by running the licence-key activation command on the machine. pyvorin auth activate --key PYV-XXXX-XXXX-XXXX The device appears in the Portal under the licence key. You can label devices to make them easier to identify later.
Updated 1 month ago
Referral Program
The Pyvorin referral program rewards you for inviting other users. Share your referral link from the Referrals page. When someone signs up and pays for a subscription, you receive account credit. Referral credits apply to future invoices. Self-referrals, bulk fake sign-ups, and other abuse patterns are detected and may result in forfeited credits or account suspension.
Updated 1 month ago
Support Tickets
Support is available to all customers through the Portal. Opening a ticketSign in to crm.pyvorin.com.Go to Support and click New Ticket.Choose a category (billing, technical, account, general).Describe the issue and attach any relevant reports. Information to includeOutput of pyvorin doctor.The command you ran or its hash.Error codes or fallback reports.Your licence key label (not the full key).
Updated 1 month ago
FAQ
Is Pyvorin a Python replacement?No. Pyvorin is a compiler and runtime that works alongside CPython. When native compilation is not possible, it falls back to CPython. Do I need an internet connection to compile?Yes, for licence verification and telemetry. The CLI caches tokens locally, but periodic online checks are required. Does Pyvorin store my source code?No. By default, Pyvorin does not upload source code. Compile events include metadata such as command hash, duration, status, and fallback reasons. What platforms are supported?Linux (glibc), macOS 12+, and Windows 10/11 on x86_64 and ARM64. How are credits used?Each successful compile deducts 1 credit from your plan balance. Error compiles do not deduct credits. Can I revoke a device?Yes. Go to the Licences page in the Portal and revoke the device. The CLI must then re-authenticate. Is there a free trial?Trial availability depends on the current plan. Check the Pricing page or your subscription details in the Portal. Where can I get support?Sign in to the Portal and open a support ticket, or email support@pyvorin.com from the address associated with your account.
Updated 1 month ago
Two-Factor Authentication
Two-factor authentication (2FA) adds an extra layer of security to your Portal account. Enable 2FA from the Security page. You will need an authenticator app that supports TOTP. After setup, sign-in attempts require both your password and a time-based code. Keep your recovery codes in a safe place. If you lose access to your authenticator, you will need them to recover your account.
Updated 1 month ago
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
Auth Login Flow
The web-based login flow connects the CLI to your Portal account without typing your password into the terminal. Run pyvorin auth login.The CLI prints a short device code and a URL.Open the URL in a browser, sign in, and enter the code.Approve the device in the Portal.The CLI receives and stores a device token. Device codes expire after 10 minutes. If the code expires, run the command again to generate a new one.
Updated 1 month ago
Licence Key Activation
Licence keys link the CLI to a subscription and control how many devices can compile. pyvorin auth activate --key PYV-XXXX-XXXX-XXXX The CLI sends the key to the Portal along with your device token. If the key is valid and the device limit has not been reached, the CLI receives a long-lived licence device token. Find your licence keys on the Licence Keys page in the Portal. Keys are masked by default; use the reveal action when activating a new device.
Updated 1 month ago