Getting Started

Install the Pyvorin thin client, configure your licence, and run your first script in under five minutes.

1. Install the Thin Client

Pyvorin is distributed as pyvorin-thin on our private package index. Install it with pip:

pip install pyvorin-thin --extra-index-url https://pypi.pyvorin.com/simple

Verify the installation:

pyvorin-thin --version

Expected output shows 1.0.0rc1 or newer.

2. Initialise Configuration

Create the default configuration file. This stores endpoints, cache paths, and telemetry preferences locally. No secrets are written.

pyvorin-thin init

The config file lives at:

Linux / macOS: ~/.pyvorin/thin_config.json
Windows: %APPDATA%\Pyvorin\thin_config.json

3. Activate Your Licence

Validate and store your licence key. The key is hashed before any network transmission.

pyvorin-thin activate PYV-XXXX

If your API URL differs from the default, pass it explicitly:

pyvorin-thin activate PYV-XXXX --api-url https://api.pyvorin.com

Check status at any time:

pyvorin-thin licence-status

4. Run a Health Check

Verify local paths, permissions, and network connectivity before compiling:

pyvorin-thin doctor --network

This checks:

Python version and platform compatibility
Config file and directory writability
Reachability of the Health, Licence, Compile, and Usage APIs
Licence validity

5. Run Your First Script

Create a simple Python file:

# hello.py
def main():
    data = [x * 2 for x in range(1000)]
    return sum(data)

if __name__ == "__main__":
    print(main())

Run it through Pyvorin:

pyvorin-thin run hello.py

By default, the thin client attempts remote compilation. If compilation succeeds, the native result is returned. If it fails, the script falls back to CPython automatically so your workload never crashes.

6. Scan for Compatibility

Before sending large files to the compile API, scan them locally:

pyvorin-thin scan hello.py

The scan reports supported constructs, unsupported features, and estimated fallback risk.