Zipline, a Pythonic Algorithmic Trading Library
Python Jupyter Notebook Other
Switch branches/tags
Latest commit b47f2fc Sep 20, 2017 @llllllllll llllllllll committed with llllllllll STY: remove unusued imports
Permalink
Failed to load latest commit information.
.github MAINT: fix bug in issue template Mar 18, 2016
ci BLD: Swap conda build args to check CI label/channel first May 24, 2017
conda BLD: Update CI files for py35 May 16, 2017
docs DOC: Removed yahoo_equities autodoc. Code was removed. Sep 12, 2017
etc Add '--allow-root' to jupyter command to avoid error starting container. Jul 2, 2017
tests STY: remove unusued imports Sep 20, 2017
zipline MAINT: clarify the changes made to the core loader Sep 20, 2017
.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 DOC: Remove mentions of Yahoo from tutorial (#1845) Jul 6, 2017
.travis.yml BLD: conda build strings changed between versions Sep 12, 2017
AUTHORS DOC Add authors file as well as script to create it. Feb 13, 2015
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 Adds Apache License, Version 2.0 Oct 8, 2012
MANIFEST.in BLD: Update MANIFEST to include .pyi and .pxi. May 27, 2016
README.rst DOC: Fix a link and typo (#1932) Sep 7, 2017
Vagrantfile DEV: Merged updated Vagrantfile with vagrant_init.sh Jul 7, 2016
appveyor.yml BLD: Update CI files for py35 May 16, 2017
setup.cfg TST: fix doctests to actually run Jun 21, 2016
setup.py ENH: new blaze core loader algorithm Jul 21, 2017
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 that supports both backtesting and live-trading. 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.
  • Zipline comes "batteries included" as many common statistics like moving average and linear regression can be readily accessed from within a user-written algorithm.
  • Input of historical data and output of performance statistics are based on Pandas DataFrames to integrate nicely into the existing PyData eco-system.
  • Statistic and machine learning libraries like matplotlib, scipy, statsmodels, and sklearn 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. From the command line, run:

$ zipline ingest
$ zipline run -f dual_moving_average.py --start 2011-1-1 --end 2012-1-1 -o dma.pickle

This will download the AAPL price data from quantopian-quandl in the specified time range and stream it through the algorithm and save the resulting performance dataframe to dma.pickle which you can then load and 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.