Skip to content

Commit 9d01ba7

Browse files
authored
DOC: Add whatsnew for zipline 1.1.1 (#1868)
* DOC: Add whatsnew for 1.1.1 * DOC: Update type stubs
1 parent bcaa7e7 commit 9d01ba7

File tree

2 files changed

+87
-23
lines changed

2 files changed

+87
-23
lines changed

docs/source/whatsnew/1.1.1.txt

+73-15
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,49 @@
1-
Development
2-
-----------
1+
Release 1.1.1
2+
-------------
33

44
:Release: 1.1.1
5-
:Date: TBD
6-
7-
.. warning::
8-
This release is still under active development. All changes listed are
9-
subject to change at any time.
5+
:Date: July 5, 2017
106

117

128
Highlights
139
~~~~~~~~~~
1410

15-
None
11+
Zipline now has broad support for futures, in addition to equities. It's also being tested and packaged for Python 3.5.
12+
13+
We also saw breaking changes occur from Yahoo changing their API endpoint, thus preventing users from downloading benchmark data needed for backtests. Since that change, we have swapped out Yahoo-related benchmarking code with references to Google Finance and have removed all deprecated Yahoo code, including the usage of custom Yahoo bundles.
1614

1715
Enhancements
1816
~~~~~~~~~~~~
1917

20-
None
18+
- Adds a property for BarData to know about current session's minutes (:issue:`1713`)
19+
20+
- Adds a better error message for non-existent root symbols (:issue:`1715:`)
21+
22+
- Adds ``StaticSids`` Pipeline Filter (:issue:`1717`)
23+
24+
- Allows ``zipline.data.data_portal.DataPortal.get_spot_value`` to accept multiple assets (:issue:`1719`)
25+
26+
- Adds ``ContinuousFuture`` to ``lookup_generic`` (:issue:`1718`)
27+
28+
- Adds CFE Adhoc Holidays to ``exchange_calendar_cfe`` (:issue:`1698`)
29+
30+
- Allows overriding of order amount rounding (:issue:`1722`)
31+
32+
- Makes continuous future adjustment style an argument (:issue:`1726`)
33+
34+
- Adds preliminary support for Futures slippage and commission models (:issue:`1738`)
35+
36+
- Fix a bug in cost basis calculation and change all mentions of ``sid`` to ``asset`` (:issue:`1757`)
37+
38+
- Add slippage and commission models for futures (:issue:`1748`)
39+
40+
- Use Python 3.5 in our Dockerfile (:issue:`1806`)
41+
42+
- Allow pipelines to be run in chunks (:issue:`1811`)
43+
44+
- Adds `get_range` to `BenchmarkSource` (:issue:`1815`)
45+
46+
- Adds support for relabeling classifiers in Pipeline (:issue:`1833`)
2147

2248
Experimental Features
2349
~~~~~~~~~~~~~~~~~~~~~
@@ -31,29 +57,61 @@ None
3157
Bug Fixes
3258
~~~~~~~~~
3359

34-
None
60+
- Fixes a floating point division issue in ``zipline.data.minute_bars`` by using integer divison instead (:issue:`1683`)
61+
62+
- Sorts data in ``zipline.pipeline.loaders.blaze.core`` on ``asof_date`` to resolve timestamp conflicts (:issue:`1710`)
63+
64+
- Swapped out Yahoo for Google Finance benchmark data (:issue:`1812`)
65+
66+
- Gold and silver futures contracts only traded during certain months (:issue:`1779`)
67+
68+
- Fixes bug in TradingCalendar initialization when we use tzaware datetimes (:issue:`1802`)
69+
70+
- Fixes precision issues on futures prices when rounding (:issue:`1788`)
3571

3672
Performance
3773
~~~~~~~~~~~
3874

39-
None
75+
- Avoid repeated recursive calls when getting forward-filled close price (:issue:`1735`)
76+
4077

4178
Maintenance and Refactorings
4279
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4380

44-
None
81+
- Adds linter recommendations to adjustments module (:issue:`1712`)
82+
83+
- Clears up naming and logic in resample close (:issue:`1728`)
84+
85+
- Use March quarterly cycle for several continuous futures (:issue:`1762`)
86+
87+
- Use better repr for Transaction objects (:issue:`1746`)
88+
89+
- Shorten repr for Asset objects (:issue:`1786`)
90+
91+
- Removes usage of empyrical's information ratio (:issue:`1854`)
92+
4593

4694
Build
4795
~~~~~
4896

49-
None
97+
- Adds Python 3.5 packages (:issue:`1701`)
98+
99+
- Swap conda-build arguments so we don't build packages on every CI build (:issue:`1813`)
50100

51101
Documentation
52102
~~~~~~~~~~~~~
53103

54-
None
104+
- Adds Zipline Development Guidelines, for people to read about how to contribute to zipline (:issue:`1820`)
105+
106+
- Show exchange as required for equities (:issue:`1731`)
107+
108+
- Updates the Zipline Beginner Tutorial notebook (:issue:`1707`)
109+
110+
- Includes PipelineEngine, pipeline Term, Factors, and other pipeline things to docs (:issue:`1826`)
55111

56112
Miscellaneous
57113
~~~~~~~~~~~~~
58114

59-
None
115+
- Use csv market data with ``run_algorithm`` so we don't try to download data for tests (:issue:`1793`)
116+
117+
- Updates Dockerfile to use Python 3.5

zipline/api.pyi

+14-8
Original file line numberDiff line numberDiff line change
@@ -542,6 +542,8 @@ def schedule_function(func, date_rule=None, time_rule=None, half_days=True, cale
542542
The rule for the times to execute this function.
543543
half_days : bool, optional
544544
Should this rule fire on half days?
545+
calendar : Sentinel, optional
546+
Calendar used to reconcile date and time rules.
545547
546548
See Also
547549
--------
@@ -590,13 +592,15 @@ def set_cancel_policy(cancel_policy):
590592
:class:`zipline.api.NeverCancel`
591593
"""
592594

593-
def set_commission(commission):
594-
"""Sets the commission model for the simulation.
595+
def set_commission(us_equities=None, us_futures=None):
596+
"""Sets the commission models for the simulation.
595597
596598
Parameters
597599
----------
598-
commission : CommissionModel
599-
The commission model to use.
600+
us_equities : EquityCommissionModel
601+
The commission model to use for trading US equities.
602+
us_futures : FutureCommissionModel
603+
The commission model to use for trading US futures.
600604
601605
See Also
602606
--------
@@ -681,13 +685,15 @@ def set_max_position_size(asset=None, max_shares=None, max_notional=None, on_err
681685
The maximum value to hold for an asset.
682686
"""
683687

684-
def set_slippage(slippage):
685-
"""Set the slippage model for the simulation.
688+
def set_slippage(us_equities=None, us_futures=None):
689+
"""Set the slippage models for the simulation.
686690
687691
Parameters
688692
----------
689-
slippage : SlippageModel
690-
The slippage model to use.
693+
us_equities : EquitySlippageModel
694+
The slippage model to use for trading US equities.
695+
us_futures : FutureSlippageModel
696+
The slippage model to use for trading US futures.
691697
692698
See Also
693699
--------

0 commit comments

Comments
 (0)