-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Docs & tutorial updates for ingesting, beginners, and csvdir #2073
Conversation
61ef96b
to
81a22cd
Compare
One observation unrelated to your changes, I would remove/reword the live-trading support sentence at the beginning of the README.rst file. |
README.rst
Outdated
PyData eco-system. | ||
- Statistic and machine learning libraries like matplotlib, scipy, | ||
PyData ecosystem. | ||
- **Statistics and Machine Learning libraries:** matplotlib, scipy, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would reword this to explain how Zipline uses or interacts with these libraries.
README.rst
Outdated
@@ -139,15 +139,15 @@ The following code implements a simple dual moving average algorithm. | |||
long_mavg=long_mavg) | |||
|
|||
|
|||
You can then run this algorithm using the Zipline CLI. From the command | |||
line, run: | |||
You can then run this algorithm using the Zipline CLI; you'll need a `Quandl <https://www.quandl.com/>`__ API key for default data bundle. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might want to link instead to the "Getting an API key" section of Quandl's docs:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"API key for default data bundle." -> "API key to download the default data bundle."
README.rst
Outdated
You can then run this algorithm using the Zipline CLI. From the command | ||
line, run: | ||
You can then run this algorithm using the Zipline CLI; you'll need a `Quandl <https://www.quandl.com/>`__ API key for default data bundle. | ||
Once you have you key, rom the command line, run: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Once you have you key, rom the command line, run:" -> "Once you have your key, run the following from the command line:"
docs/source/beginner-tutorial.rst
Outdated
Run a backtest for the given algorithm. | ||
|
||
Options: | ||
-f, --algofile FILENAME The file that contains the algorithm to run. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like the indentation here got messed up.
README.rst
Outdated
|
||
This will download the AAPL price data from `quantopian-quandl` in the | ||
This will download the AAPL price data from `quandl` in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would generalize this a bit:
"This will download asset pricing 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 and analyze from within Python.
docs/source/beginner-tutorial.rst
Outdated
@@ -101,14 +101,15 @@ interfaces: A command-line interface, ``IPython Notebook`` magic, and | |||
|
|||
Ingesting Data | |||
^^^^^^^^^^^^^^ | |||
If you haven't ingested the data, run: | |||
If you haven't ingested the data, you'll need a `Quandl <https://www.quandl.com/>`__ API key to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as before, we might want to link to https://docs.quandl.com/docs#section-authentication instead.
docs/source/bundles.rst
Outdated
@@ -47,15 +47,15 @@ process will invoke some custom bundle command and then write the data to a | |||
standard location that zipline can find. By default the location where ingested | |||
data will be written is ``$ZIPLINE_ROOT/data/<bundle>`` where by default | |||
``ZIPLINE_ROOT=~/.zipline``. The ingestion step may take some time as it could | |||
involve downloading and processing a lot of data. This can be run with: | |||
involve downloading and processing a lot of data. You'll need a | |||
`Quandl <https://www.quandl.com/>`__ API key to ingest the default bundle. This can be run with: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might want to link to "Getting an API key" section of Quandl docs, https://docs.quandl.com/docs#section-authentication
3064313
to
031ec69
Compare
031ec69
to
519d9af
Compare
@ernestoeperez88 should be good for another review |
README.rst
Outdated
@@ -13,28 +13,28 @@ | |||
|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 | |||
system that for backtesting. Zipline is currently used in production as the backtesting and live-trading |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"It is an event-drive system that for" -> "It is an event driven system for backtesting"
README.rst
Outdated
You can then run this algorithm using the Zipline CLI. From the command | ||
line, run: | ||
You can then run this algorithm using the Zipline CLI; you'll need a `Quandl <https://docs.quandl.com/docs#section-authentication>`__ API key to ingest the default data bundle. | ||
Once you have you key, run the following from the command line: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Once you have you key" -> "Once you have your key"
@freddiev4 left comments on a couple of typos, otherwise LGTM. |
@ernestoeperez88 ok sweet. Will update and then merge 🙂 |
519d9af
to
ec151a0
Compare
Added some much needed doc updates here and also a mini tutorial for using
.csv
files for your bundles (x-ref #2060)