Skip to content

Commit b365c8c

Browse files
maread99beppe712
authored andcommitted
Update readme (quantopian#176)
Update readme Makes changes to readme advising of: - 4.0 development. - New library market_prices.
1 parent 46f2e66 commit b365c8c

File tree

1 file changed

+38
-25
lines changed

1 file changed

+38
-25
lines changed

README.md

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,25 @@ A Python library for defining and querying calendars for security exchanges.
66

77
Calendars for more than [50 exchanges](#Calendars) available out-the-box! If you still can't find the calendar you're looking for, [create a new one](#How-can-I-create-a-new-calendar)!
88

9-
## **What's new in 3.4?** (October 2021)
10-
Quite a bit! (Please offer any feedback at the [3.4 discussion](https://github.com/gerrymanoim/exchange_calendars/discussions/107))
119

12-
* [Tutorials](#Tutorials). Five of them!
13-
* New calendar methods [#71](https://github.com/gerrymanoim/exchange_calendars/pull/71) (see [calendar_methods.ipynb](docs/tutorials/calendar_methods.ipynb) for usage), including:
14-
* trading_index (tutorial [trading_index.ipynb](docs/tutorials/trading_index.ipynb))
15-
* is_trading_minute
16-
* is_break_minute
17-
* minute_offset
18-
* session_offset
19-
* minute_offset_by_sessions
20-
* Calendar's now have a `side` parameter to determine which of the open, close, break-start and break-end minutes are treated as trading minutes [#71](https://github.com/gerrymanoim/exchange_calendars/pull/71).
21-
* 24 hour calendars are now truly 24 hours (open/close times are no longer one minute later/earlier than the actual open/close) [#71](https://github.com/gerrymanoim/exchange_calendars/pull/71).
22-
* Some calendar methods have been renamed to improve consistency (table of changes [here](#Methods-renamed-in-version-34)) [#85](https://github.com/gerrymanoim/exchange_calendars/issues/85). The previous names will continue to be available until version 4.0. NOTE: Some newly named methods have also made changes to parameter names, for example from `session_label` to `session` and from `start_session_label` to `start`.
23-
* Under-the-bonnet work has sped up many methods.
24-
* A test suite overhaul ([#71](https://github.com/gerrymanoim/exchange_calendars/pull/71), [#92](https://github.com/gerrymanoim/exchange_calendars/pull/92), [#96](https://github.com/gerrymanoim/exchange_calendars/pull/96)) has made it simpler to define and test calendars.
10+
## **NOTICES: All change!**
11+
12+
### **Release 3.6.3 will be the last stop for version 3!**
13+
The final release for version 3 will be v3.6.3 (due before end May 22). See [#175](https://github.com/gerrymanoim/exchange_calendars/issues/175) for information on PRs received ahead of release v4.0.
14+
15+
### What to expect in 4.0 (June 2022)
16+
Major changes to be introduced in 4.0 include:
17+
* Changes to the timezone of sessions and times ([#142](https://github.com/gerrymanoim/exchange_calendars/issues/42)). **This will** (probably) **break dependent packages!**
18+
* Schedule times to change from tz-naive to "UTC".
19+
* Sessions to change from "UTC" to tz-naive.
20+
* Renaming of further methods and method parameters to improve consistency.
21+
* Minimum supported Python version to advance from 3.7 to 3.8.
22+
* For those [methods renamed in 3.4](#Methods-renamed-in-version-34), the old method names will be removed.
23+
24+
See the [path to 4.0](https://github.com/gerrymanoim/exchange_calendars/issues/61) for a fuller list.
25+
26+
### **New library for prices data!**
27+
If you like the idea of [using `exchange_calendars` to create meaningful OHLCV datasets](https://github.com/maread99/market_prices#exchange_calendars) then check out the new [`market_prices`](https://github.com/maread99/market_prices) library. Works out-the-box with freely available data!
2528

2629
## Installation
2730

@@ -193,7 +196,26 @@ ecal XNYS 1 2020
193196
[19][20] 21 22 23 24 [25]
194197
[26] 27 28 29 30 31
195198

196-
## Methods renamed in version 3.4
199+
## **Changes in 3.4** (released October 2021)
200+
The 3.4 release introduced notable new features and documentation, including:
201+
202+
* [Tutorials](#Tutorials). Five of them!
203+
* New calendar methods [#71](https://github.com/gerrymanoim/exchange_calendars/pull/71) (see [calendar_methods.ipynb](docs/tutorials/calendar_methods.ipynb) for usage), including:
204+
* trading_index (tutorial [trading_index.ipynb](docs/tutorials/trading_index.ipynb))
205+
* is_trading_minute
206+
* is_break_minute
207+
* minute_offset
208+
* session_offset
209+
* minute_offset_by_sessions
210+
* Calendar's now have a `side` parameter to determine which of the open, close, break-start and break-end minutes are treated as trading minutes [#71](https://github.com/gerrymanoim/exchange_calendars/pull/71).
211+
* 24 hour calendars are now truly 24 hours (open/close times are no longer one minute later/earlier than the actual open/close) [#71](https://github.com/gerrymanoim/exchange_calendars/pull/71).
212+
* Some calendar methods have been renamed to improve consistency (table of changes [here](#Methods-renamed-in-version-34)) [#85](https://github.com/gerrymanoim/exchange_calendars/issues/85). The previous names will continue to be available until version 4.0. NOTE: Some newly named methods have also made changes to parameter names, for example from `session_label` to `session` and from `start_session_label` to `start`.
213+
* Under-the-bonnet work has sped up many methods.
214+
* A test suite overhaul ([#71](https://github.com/gerrymanoim/exchange_calendars/pull/71), [#92](https://github.com/gerrymanoim/exchange_calendars/pull/92), [#96](https://github.com/gerrymanoim/exchange_calendars/pull/96)) has made it simpler to define and test calendars.
215+
216+
Please offer any feedback at the [3.4 discussion](https://github.com/gerrymanoim/exchange_calendars/discussions/107).
217+
218+
### Methods renamed in version 3.4
197219
| Previous Name | New Name |
198220
| ------------- | -------- |
199221
| previous_session_label | previous_session |
@@ -217,15 +239,6 @@ ecal XNYS 1 2020
217239
| market_break_starts_nanos | break_starts_nanos |
218240
| market_break_ends_nanos | break_ends_nanos |
219241

220-
## What to expect in 4.0? (April 2022)
221-
Major anticipated changes in 4.0 include the following (see the [path to 4.0](https://github.com/gerrymanoim/exchange_calendars/issues/61) for a fuller list):
222-
* Changes to the timezone of returned sessions and times (these changes are not yet set in stone - please have your say [here](https://github.com/gerrymanoim/exchange_calendars/issues/42)).
223-
* Schedule times to change from tz-naive to "UTC".
224-
* Sessions to change from "UTC" to tz-naive.
225-
* Renaming of some methods and method parameters to provide consistency across the package.
226-
* Minimum supported Python version to advance from 3.7 to 3.8.
227-
* For those [methods renamed in 3.4](#Methods-renamed-in-version-34), the previous method names will be removed.
228-
229242
## Frequently Asked Questions
230243

231244
### **How can I create a new calendar?**

0 commit comments

Comments
 (0)