$ zipline ingest [-b <bundle>]
+$ zipline ingest [-b <bundle>]
where <bundle> is the name of the bundle to ingest, defaulting to
@@ -212,17 +349,17 @@ we can list all of the ingestions with the clean, which will clear data bundles based on some time
constraints.
For example:
-# clean everything older than <date>
-$ zipline clean [-b <bundle>] --before <date>
+# clean everything older than <date>
+$ zipline clean [-b <bundle>] --before <date>
-# clean everything newer than <date>
-$ zipline clean [-b <bundle>] --after <date>
+# clean everything newer than <date>
+$ zipline clean [-b <bundle>] --after <date>
-# keep everything in the range of [before, after] and delete the rest
-$ zipline clean [-b <bundle>] --before <date> --after <after>
+# keep everything in the range of [before, after] and delete the rest
+$ zipline clean [-b <bundle>] --before <date> --after <after>
-# clean all but the last <int> runs
-$ zipline clean [-b <bundle>] --keep-last <int>
+# clean all but the last <int> runs
+$ zipline clean [-b <bundle>] --keep-last <int>
@@ -231,7 +368,7 @@ $ zipline clean
[-b <bundle>
]Now that the data has been ingested we can use it to run backtests with the
run command. The bundle to use can be specified with the
--bundle option
like:
-
$ zipline run --bundle <bundle> --algofile algo.py ...
+$ zipline run --bundle <bundle> --algofile algo.py ...
We may also specify the date to use to look up the bundle data with the
@@ -253,7 +390,7 @@ includes daily pricing data, splits, cash dividends, and asset metadata. To
ingest the quandl data bundle we recommend creating an account on quandl.com
to get an API key to be able to make more API requests per day. Once we have an
API key we may run:
-$ QUANDL_API_KEY=<api-key> zipline ingest -b quandl
+$ QUANDL_API_KEY=<api-key> zipline ingest -b quandl
though we may still run ingest as an anonymous quandl user (with no API
@@ -284,23 +421,23 @@ cache the data for a set of equities from yahoo. The yahoo bundles include daily
pricing data along with splits, cash dividends, and inferred asset metadata. To
create a bundle from a set of equities, add the following to your
~/.zipline/extensions.py file:
-from zipline.data.bundles import register, yahoo_equities
+from zipline.data.bundles import register, yahoo_equities
-# these are the tickers you would like data for
+# these are the tickers you would like data for
equities = {
- 'AAPL',
- 'MSFT',
- 'GOOG',
+ 'AAPL',
+ 'MSFT',
+ 'GOOG',
}
register(
- 'my-yahoo-equities-bundle', # name this whatever you like
+ 'my-yahoo-equities-bundle', # name this whatever you like
yahoo_equities(equities),
)
This may now be used like:
-$ zipline ingest -b my-yahoo-equities-bundle
-$ zipline run -f algo.py --bundle my-yahoo-equities-bundle
+$ zipline ingest -b my-yahoo-equities-bundle
+$ zipline run -f algo.py --bundle my-yahoo-equities-bundle
More than one yahoo equities bundle may be registered as long as they use
@@ -320,7 +457,7 @@ writers that will write the data to the correct location transactionally. If an
ingestion fails part way through the bundle will not be written in an incomplete
state.
The signature of the ingest function should be:
-ingest(environ,
+ingest(environ,
asset_db_writer,
minute_bar_writer,
daily_bar_writer,
@@ -456,10 +593,6 @@ bundle uses this to directly untar the bundle into the
-
-
- Built with
Sphinx using a
theme provided by
Read the Docs.
+ Built with
Sphinx using a
theme provided by
Read the Docs.
@@ -493,8 +625,7 @@ bundle uses this to directly untar the bundle into the
diff --git a/development-guidelines.html b/development-guidelines.html
index 2dd0d3ba..cc74aef5 100644
--- a/development-guidelines.html
+++ b/development-guidelines.html
@@ -13,8 +13,6 @@
-
-
@@ -43,28 +41,21 @@
-