DOC: Docs & tutorial updates for ingesting, beginners, and csvdir #2073

freddiev4 · 2018-01-03T05:24:19Z

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

coveralls · 2018-01-03T05:45:19Z

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

coveralls · 2018-01-03T05:47:14Z

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

coveralls · 2018-01-03T06:05:58Z

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

coveralls · 2018-01-03T06:06:32Z

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

coveralls · 2018-01-03T06:06:34Z

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

coveralls · 2018-01-03T06:43:37Z

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

ernestoeperez88 · 2018-01-04T18:55:24Z

One observation unrelated to your changes, I would remove/reword the live-trading support sentence at the beginning of the README.rst file.

ernestoeperez88 · 2018-01-04T18:56:53Z

README.rst

-  PyData eco-system.
- Statistic and machine learning libraries like matplotlib, scipy,
+  PyData ecosystem.
+- **Statistics and Machine Learning libraries:** matplotlib, scipy,


I would reword this to explain how Zipline uses or interacts with these libraries.

ernestoeperez88 · 2018-01-04T19:00:00Z

README.rst

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


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

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

"API key for default data bundle." -> "API key to download the default data bundle."

ernestoeperez88 · 2018-01-04T19:20:30Z

README.rst

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


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

richafrank · 2018-01-04T19:30:12Z

docs/source/beginner-tutorial.rst

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


Looks like the indentation here got messed up.

ernestoeperez88 · 2018-01-04T19:32:18Z

README.rst


-This will download the AAPL price data from `quantopian-quandl` in the
+This will download the AAPL price data from `quandl` in the


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.

ernestoeperez88 · 2018-01-04T20:25:49Z

docs/source/beginner-tutorial.rst

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


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

ernestoeperez88 · 2018-01-04T20:28:24Z

docs/source/bundles.rst

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


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

coveralls · 2018-01-06T00:09:35Z

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

coveralls · 2018-01-06T00:10:28Z

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

freddiev4 · 2018-01-08T06:34:43Z

@ernestoeperez88 should be good for another review

coveralls · 2018-01-08T07:42:46Z

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

ernestoeperez88 · 2018-01-08T15:41:46Z

README.rst

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


"It is an event-drive system that for" -> "It is an event driven system for backtesting"

ernestoeperez88 · 2018-01-08T15:42:28Z

README.rst

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


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

ernestoeperez88 · 2018-01-08T15:47:53Z

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

freddiev4 · 2018-01-08T19:50:12Z

@ernestoeperez88 ok sweet. Will update and then merge 🙂

coveralls · 2018-01-08T20:19:22Z

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

freddiev4 force-pushed the update-tutorial-and-docs branch from 61ef96b to 81a22cd Compare January 3, 2018 05:27

freddiev4 mentioned this pull request Jan 3, 2018

Can zipline use min or sec frequency data? #407

Closed

ernestoeperez88 reviewed Jan 4, 2018

View reviewed changes

richafrank reviewed Jan 4, 2018

View reviewed changes

ernestoeperez88 reviewed Jan 4, 2018

View reviewed changes

freddiev4 force-pushed the update-tutorial-and-docs branch from 3064313 to 031ec69 Compare January 5, 2018 23:38

freddiev4 force-pushed the update-tutorial-and-docs branch from 031ec69 to 519d9af Compare January 8, 2018 06:34

ernestoeperez88 reviewed Jan 8, 2018

View reviewed changes

DOC: Docs & tutorial updates for ingesting, beginners, and csvdir

ec151a0

freddiev4 force-pushed the update-tutorial-and-docs branch from 519d9af to ec151a0 Compare January 8, 2018 19:55

freddiev4 merged commit 5193f02 into master Jan 8, 2018

freddiev4 deleted the update-tutorial-and-docs branch January 8, 2018 20:28

freddiev4 mentioned this pull request Jan 10, 2018

Add csvdir usage to bundle docs #2060

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Docs & tutorial updates for ingesting, beginners, and csvdir #2073

DOC: Docs & tutorial updates for ingesting, beginners, and csvdir #2073

freddiev4 commented Jan 3, 2018

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018 •

edited

Loading

ernestoeperez88 commented Jan 4, 2018

ernestoeperez88 Jan 4, 2018

ernestoeperez88 Jan 4, 2018

ernestoeperez88 Jan 4, 2018

ernestoeperez88 Jan 4, 2018

richafrank Jan 4, 2018

ernestoeperez88 Jan 4, 2018

ernestoeperez88 Jan 4, 2018

ernestoeperez88 Jan 4, 2018

coveralls commented Jan 6, 2018 •

edited

Loading

coveralls commented Jan 6, 2018 •

edited

Loading

freddiev4 commented Jan 8, 2018

coveralls commented Jan 8, 2018 •

edited

Loading

ernestoeperez88 Jan 8, 2018

ernestoeperez88 Jan 8, 2018

ernestoeperez88 commented Jan 8, 2018

freddiev4 commented Jan 8, 2018

coveralls commented Jan 8, 2018 •

edited

Loading


		This will download the AAPL price data from `quantopian-quandl` in the
		This will download the AAPL price data from `quandl` in the

DOC: Docs & tutorial updates for ingesting, beginners, and csvdir #2073

DOC: Docs & tutorial updates for ingesting, beginners, and csvdir #2073

Conversation

freddiev4 commented Jan 3, 2018

coveralls commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018 • edited Loading

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018

coveralls commented Jan 3, 2018 • edited Loading

ernestoeperez88 commented Jan 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Jan 6, 2018 • edited Loading

coveralls commented Jan 6, 2018 • edited Loading

freddiev4 commented Jan 8, 2018

coveralls commented Jan 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ernestoeperez88 commented Jan 8, 2018

freddiev4 commented Jan 8, 2018

coveralls commented Jan 8, 2018 • edited Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 3, 2018 •

edited

Loading

coveralls commented Jan 6, 2018 •

edited

Loading

coveralls commented Jan 6, 2018 •

edited

Loading

coveralls commented Jan 8, 2018 •

edited

Loading

coveralls commented Jan 8, 2018 •

edited

Loading