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

Merged
merged 1 commit into from Jan 8, 2018

Conversation

Projects
None yet
4 participants
@freddiev4
Contributor

freddiev4 commented Jan 3, 2018

Added some much needed doc updates here and also a mini tutorial for using .csv files for your bundles (x-ref #2060)

@freddiev4 freddiev4 force-pushed the update-tutorial-and-docs branch from 61ef96b to 81a22cd Jan 3, 2018

@coveralls

This comment has been minimized.

coveralls commented Jan 3, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling aebd317 on update-tutorial-and-docs into 5978f68 on master.

@coveralls

This comment has been minimized.

coveralls commented Jan 3, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling aebd317 on update-tutorial-and-docs into 5978f68 on master.

@coveralls

This comment has been minimized.

coveralls commented Jan 3, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling 0760426 on update-tutorial-and-docs into 5978f68 on master.

@coveralls

This comment has been minimized.

coveralls commented Jan 3, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling 0760426 on update-tutorial-and-docs into 5978f68 on master.

@coveralls

This comment has been minimized.

coveralls commented Jan 3, 2018

Coverage Status

Coverage decreased (-0.06%) to 87.512% when pulling 0760426 on update-tutorial-and-docs into 5978f68 on master.

@coveralls

This comment has been minimized.

coveralls commented Jan 3, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling 0760426 on update-tutorial-and-docs into 5978f68 on master.

@ernestoeperez88

This comment has been minimized.

Member

ernestoeperez88 commented Jan 4, 2018

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,

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

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.

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

Might want to link instead to the "Getting an API key" section of Quandl's docs:

https://docs.quandl.com/docs#section-authentication

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

"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:

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

"Once you have you key, rom the command line, run:" -> "Once you have your key, run the following from the command line:"

Run a backtest for the given algorithm.
Options:
-f, --algofile FILENAME The file that contains the algorithm to run.

This comment has been minimized.

@richafrank

richafrank Jan 4, 2018

Member

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

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

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.

@@ -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

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

Same comment as before, we might want to link to https://docs.quandl.com/docs#section-authentication instead.

@@ -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:

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 4, 2018

Member

We might want to link to "Getting an API key" section of Quandl docs, https://docs.quandl.com/docs#section-authentication

@freddiev4 freddiev4 force-pushed the update-tutorial-and-docs branch from 3064313 to 031ec69 Jan 5, 2018

@coveralls

This comment has been minimized.

coveralls commented Jan 6, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling 031ec69 on update-tutorial-and-docs into 503fd34 on master.

@coveralls

This comment has been minimized.

coveralls commented Jan 6, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling 031ec69 on update-tutorial-and-docs into 503fd34 on master.

@freddiev4 freddiev4 force-pushed the update-tutorial-and-docs branch from 031ec69 to 519d9af Jan 8, 2018

@freddiev4

This comment has been minimized.

Contributor

freddiev4 commented Jan 8, 2018

@ernestoeperez88 should be good for another review

@coveralls

This comment has been minimized.

coveralls commented Jan 8, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling 519d9af on update-tutorial-and-docs into 503fd34 on master.

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

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 8, 2018

Member

"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:

This comment has been minimized.

@ernestoeperez88

ernestoeperez88 Jan 8, 2018

Member

"Once you have you key" -> "Once you have your key"

@ernestoeperez88

This comment has been minimized.

Member

ernestoeperez88 commented Jan 8, 2018

@freddiev4 left comments on a couple of typos, otherwise LGTM.

@freddiev4

This comment has been minimized.

Contributor

freddiev4 commented Jan 8, 2018

@ernestoeperez88 ok sweet. Will update and then merge 🙂

@freddiev4 freddiev4 force-pushed the update-tutorial-and-docs branch from 519d9af to ec151a0 Jan 8, 2018

@coveralls

This comment has been minimized.

coveralls commented Jan 8, 2018

Coverage Status

Coverage remained the same at 87.577% when pulling ec151a0 on update-tutorial-and-docs into 503fd34 on master.

@freddiev4 freddiev4 merged commit 5193f02 into master Jan 8, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@freddiev4 freddiev4 deleted the update-tutorial-and-docs branch Jan 8, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment