Zipline, a Pythonic Algorithmic Trading Library
Python Jupyter Notebook Shell Batchfile PowerShell Dockerfile
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github MAINT: Put environment info in a `<details>` tag. Jul 2, 2018
ci MAINT: Factor out ci helper scripts Jul 11, 2018
conda BLD: Added numexpr conda recipe Jul 10, 2018
docs DOC: Updated release process around CI conda packaging (#2255) Jul 20, 2018
etc MAINT: Bump responses version. Jul 17, 2018
tests BUG: Updating window safety validation with window_length > 1 Aug 1, 2018
zipline BUG: Updating window safety validation with window_length > 1 Aug 1, 2018
.appveyor.yml MAINT: Rename for consistency with Travis config Jul 11, 2018
.coveragerc TST/BUG: Cover all reindex session public methods. Sep 1, 2016
.dir-locals.el STY: Normalize styles across installations via .dir-locals.el Jun 4, 2014
.dockerignore Added a Dockerfile for repeatable runtimes Apr 4, 2016
.gitattributes MAINT: Mark .ipynb files as binary. May 9, 2017
.gitignore ENH: new risk metrics API Feb 26, 2018
.travis.yml MAINT: Factor out ci helper scripts Jul 11, 2018
AUTHORS DOC Add authors file as well as script to create it. Feb 13, 2015
CONTRIBUTING.rst STY: Fix .rst formatting Dec 11, 2017
Dockerfile Added missing "-o" parameter to Dockerfile instructions. Jul 2, 2017
Dockerfile-dev updated dockerfiles with instructions for dealing with common build f… May 23, 2017
LICENSE MAINT: add year/name to license Jun 15, 2018
MANIFEST.in REL: Add .pxd files to MANIFEST.in Apr 4, 2018
README.rst DOC: Docs & tutorial updates for ingesting, beginners, and csvdir Jan 8, 2018
Vagrantfile DEV: Merged updated Vagrantfile with vagrant_init.sh Jul 7, 2016
setup.cfg Include LICENSE file in wheels (#2209) Jun 14, 2018
setup.py BLD: Add Pandas 0.19.2 to build matrix Jul 10, 2018
vagrant_init.sh MAINT: Updated ta-lib source download urls to https Nov 14, 2016
versioneer.py BLD: Adds versioneer Nov 11, 2015

README.rst

Zipline

Gitter version status travis status appveyor status Coverage Status

Zipline is a Pythonic algorithmic trading library. It is an event-driven system for backtesting. Zipline is currently used in production as the backtesting and live-trading engine powering Quantopian -- a free, community-centered, hosted platform for building and executing trading strategies.

Features

  • Ease of Use: Zipline tries to get out of your way so that you can focus on algorithm development. See below for a code example.
  • "Batteries Included": many common statistics like moving average and linear regression can be readily accessed from within a user-written algorithm.
  • PyData Integration: Input of historical data and output of performance statistics are based on Pandas DataFrames to integrate nicely into the existing PyData ecosystem.
  • Statistics and Machine Learning Libraries: You can use libraries like matplotlib, scipy, statsmodels, and sklearn to support development, analysis, and visualization of state-of-the-art trading systems.

Installation

Installing With pip

Assuming you have all required (see note below) non-Python dependencies, you can install Zipline with pip via:

$ pip install zipline

Note: Installing Zipline via pip is slightly more involved than the average Python package. Simply running pip install zipline will likely fail if you've never installed any scientific Python packages before.

There are two reasons for the additional complexity:

  1. Zipline ships several C extensions that require access to the CPython C API. In order to build the C extensions, pip needs access to the CPython header files for your Python installation.
  2. Zipline depends on numpy, the core library for numerical array computing in Python. Numpy depends on having the LAPACK linear algebra routines available.

Because LAPACK and the CPython headers are binary dependencies, the correct way to install them varies from platform to platform. On Linux, users generally acquire these dependencies via a package manager like apt, yum, or pacman. On OSX, Homebrew is a popular choice providing similar functionality.

See the full Zipline Install Documentation for more information on acquiring binary dependencies for your specific platform.

conda

Another way to install Zipline is via the conda package manager, which comes as part of Anaconda or can be installed via pip install conda.

Once set up, you can install Zipline from our Quantopian channel:

$ conda install -c Quantopian zipline

Currently supported platforms include:

  • GNU/Linux 64-bit
  • OSX 64-bit
  • Windows 64-bit

Note

Windows 32-bit may work; however, it is not currently included in continuous integration tests.

Quickstart

See our getting started tutorial.

The following code implements a simple dual moving average algorithm.

from zipline.api import order_target, record, symbol

def initialize(context):
    context.i = 0
    context.asset = symbol('AAPL')


def handle_data(context, data):
    # Skip first 300 days to get full windows
    context.i += 1
    if context.i < 300:
        return

    # Compute averages
    # data.history() has to be called with the same params
    # from above and returns a pandas dataframe.
    short_mavg = data.history(context.asset, 'price', bar_count=100, frequency="1d").mean()
    long_mavg = data.history(context.asset, 'price', bar_count=300, frequency="1d").mean()

    # Trading logic
    if short_mavg > long_mavg:
        # order_target orders as many shares as needed to
        # achieve the desired number of shares.
        order_target(context.asset, 100)
    elif short_mavg < long_mavg:
        order_target(context.asset, 0)

    # Save values for later inspection
    record(AAPL=data.current(context.asset, 'price'),
           short_mavg=short_mavg,
           long_mavg=long_mavg)

You can then run this algorithm using the Zipline CLI; you'll need a Quandl API key to ingest the default data bundle. Once you have your key, run the following from the command line:

$ QUANDL_API_KEY=<yourkey> zipline ingest -b quandl
$ zipline run -f dual_moving_average.py --start 2014-1-1 --end 2018-1-1 -o dma.pickle

This will download asset pricing data data from quandl, and stream it through the algorithm over the specified time range. Then, the resulting performance DataFrame is saved in dma.pickle, which you can load an analyze from within Python.

You can find other examples in the zipline/examples directory.

Questions?

If you find a bug, feel free to open an issue and fill out the issue template.

Contributing

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. Details on how to set up a development environment can be found in our development guidelines.

If you are looking to start working with the Zipline codebase, navigate to the GitHub issues tab and start looking through interesting issues. Sometimes there are issues labeled as Beginner Friendly or Help Wanted.

Feel free to ask questions on the mailing list or on Gitter.