Skip to content

Quickstart Guide

Get Opteryx running in minutes.

Requirements

  • OS: Linux, macOS, or Windows (Windows is supported but not recommended for production use)
  • Python: 3.10 or later

We recommend using a virtual environment:

$ python -m venv myenv
$ source myenv/bin/activate  # On Windows, use `myenv\Scripts\activate`
$ pip install --upgrade opteryx

This installs the latest stable release.

Install from Source (Bleeding-edge)

If you want the latest features or are contributing to Opteryx, install directly from GitHub:

$ pip install git+https://github.com/mabel-dev/opteryx

Note

Source builds may include unstable or experimental features and can have additional dependencies. Not recommended for production.

Verify Installation

Run in Python:

import opteryx
print(opteryx.query("SELECT 'Hello, Opteryx!'"))

Resources

Ready to use it in Python? See the Python Integration Guide