Installation ¶

The package is tested against Python 3.9, 3.10, 3.11 on 64-bit Linux, macOS and Windows. We recommend running the platform with the latest stable version of Python, and in a virtual environment to isolate the dependencies.

From PyPI ¶

To install the latest binary wheel (or sdist package) from PyPI:

pip install -U nautilus_trader

Extras ¶

Also, the following optional dependency ‘extras’ are separately available for installation.

betfair - package required for the Betfair integration
docker - package required for docker when using the IB gateway
ib - package required for the Interactive Brokers adapter
redis - packages required to use Redis as a cache database

For example, to install including the docker , ib and redis extras using pip:

pip install -U nautilus_trader[docker,ib,redis]

From Source ¶

Installation from source requires the Python.h header file, which is included in development releases such as python-dev . You’ll also need the latest stable rustc and cargo to compile the Rust libraries.

For MacBook Pro M1/M2, make sure your Python installed using pyenv is configured with –enable-shared:

PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install <python_version>

See https://pyo3.rs/latest/getting_started#virtualenvs .

It’s possible to install from source using pip if you first install the build dependencies as specified in the pyproject.toml . However, we highly recommend installing using poetry as below.

Install rustup (the Rust toolchain installer):
- Linux and macOS:
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
- Windows:
  - Download and install rustup-init.exe
  - Install “Desktop development with C++” with Build Tools for Visual Studio 2019
Enable cargo in the current shell:
- Linux and macOS:
```
source $HOME/.cargo/env
```
- Windows:
  - Start a new PowerShell
Install poetry (or follow the installation guide on their site):
```
curl -sSL https://install.python-poetry.org | python3 -
```

Clone the source with git , and install from the projects root directory:

             git clone https://github.com/nautechsystems/nautilus_trader
cd nautilus_trader
poetry install --only main --all-extras

            

From GitHub Release ¶

To install a binary wheel from GitHub, first navigate to the latest release . Download the appropriate .whl for your operating system and Python version, then run:

pip install <file-name>.whl