PyZipline/docs/getting-started/installation.md
SeaswimmerTheFsh 14db5cae69
All checks were successful
Actions / Lint Code (Pylint) (push) Successful in 5s
Actions / Build Documentation (MkDocs) (push) Successful in 9s
fix(docs): update for zipline 3.7.8
2024-01-15 06:17:07 -05:00

1.5 KiB

Installation

/// admonition | This project is in active development type: danger There has not been an official release of PyZipline on PyPi yet, meaning these installation docs don't work. ///

/// admonition | Using the correct version type: warning attrs: {class: annotate} Please make sure to install the matching version of PyZipline for your Zipline version!
This documentation assumes you are using Zipline 3.7.8.
If you are not, please see Versioning for a list of supported versions.
If you're on Zipline's trunk version, use * to get the latest versions of PyZipline. (1) ///

  1. I will not always update to trunk versions, I may occassionally do so, but for the most part, expect breaking changes to recieve fixes when a new Zipline version is released.

pip

You can use pip to install PyZipline.
The command to use differs slightly depending on what operating system you use.

On Windows:

py -m pip install pyzipline=0.1.0

On macOS and Linux:

python3 -m pip install pyzipline=0.1.0

Poetry

You can also use Poetry to store your dependencies.
Use the following command to install PyZipline:

poetry add pyzipline=0.1.0

Or, you can add PyZipline to your pyproject.toml file manually:

[tool.poetry.dependencies]
pyzipline = "0.1.0"