From 70be540a20adc5a54db50874ce79b036ec2e1fce Mon Sep 17 00:00:00 2001 From: Steve Phelps Date: Wed, 23 Aug 2023 12:16:46 +0100 Subject: [PATCH] installation instructions --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/README.md b/README.md index 2d0a5c8..3b8faca 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,56 @@ [![Anaconda-Server Badge](https://anaconda.org/mesonomics/zipline-tardis-bundle/badges/platforms.svg)](https://anaconda.org/mesonomics/zipline-tardis-bundle) [![Anaconda-Server Badge](https://anaconda.org/mesonomics/zipline-tardis-bundle/badges/version.svg)](https://anaconda.org/mesonomics/zipline-tardis-bundle) [![Anaconda-Server Badge](https://anaconda.org/mesonomics/zipline-tardis-bundle/badges/downloads.svg)](https://anaconda.org/mesonomics/zipline-tardis-bundle) + +A bundle for [zipline-reloaded](https://zipline.ml4trading.io/) to allow data for crypto assets to be ingested from +[Tardis](https://tardis.dev/). + +## Installation + +### 1. Install a conda distribution + +If not already installed, install either: + - [Anaconda](https://www.anaconda.com/download/) or, + - [mambaforge](https://github.com/conda-forge/miniforge#mambaforge) (recommended). + +### 2. Install the conda package: + +Run the following in a shell: + +~~~bash +conda install -c mesonomics zipline-tardis-bundle +~~~ + +### 3. Install the configuration file: + +Run the following in a shell: + +~~~bash +install-tardis-bundle +~~~ + +### 4. Configure Zipline settings + +- Edit `~/.zipline/extension.py` with appropriate values, and configure your API key. + +### 5. Ensure Tardis bundles are available: + +Run the following in a shell: + +~~~bash +zipline bundles +~~~ + +This should show some tardis bundles, e.g.: + +~~~ +custom-tardis-bundle +tardis-coinbase-since-2019-GBP +tardis-coinbase-since-2019-USD +tardis-coinbase-since-2020-GBP +tardis-coinbase-since-2020-USD +tardis-coinbase-since-2021-GBP +tardis-coinbase-since-2021-USD +tardis-coinbase-since-2022-GBP +tardis-coinbase-since-2022-USD +~~~