From a4d173d354935467adfd2814c975ee7ede836502 Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Sat, 25 May 2024 20:27:20 -0400 Subject: [PATCH 1/4] dev: prep 0.15 release --- HISTORY.rst | 8 +++++++- README.rst | 30 +++++++++++++++--------------- 2 files changed, 22 insertions(+), 16 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index a9ae0a9..85b6341 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,10 +1,16 @@ ======= History ======= -0.15.0 (2021-XX - Unreleased) +0.16.0 (2024-XX - Unreleased) +-------------------------------- + +0.15.0 (2024-05-25) -------------------------------- * Documentation: Add crypto endpoint examples (#621) +* Development: Code is formatted with black: (#663) +* CI: No longer testing Python versions older than 3.10 (#944) +* Minor: bumped development / examples dependencies 0.14.0 (2021-03-06) -------------------------------- diff --git a/README.rst b/README.rst index 1d7a7cf..7f00e49 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,7 @@ Tiingo Python -Tiingo is a financial data platform that makes high quality financial tools available to all. Tiingo has a REST and Real-Time Data API, which this library helps you to access. Presently, the API includes support for the following endpoints: +Tiingo is a financial data platform making high quality financial tools available to all. Tiingo has a REST and Real-Time Data API, which this library helps you access. The API includes support for these endpoints: * Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine. * Curated news from top financial news sources + blogs. Stories are tagged with topic tags and relevant stock tickers by Tiingo's algorithms. @@ -158,25 +158,25 @@ You can specify any of the end of day frequencies (daily, weekly, monthly, and a methods. Weekly frequencies resample to the end of day on Friday, monthly frequencies resample to the last day of the month, and annually frequencies resample to the end of day on 12-31 of each year. The intraday frequencies are specified using an integer followed by "Min" or "Hour", for example "30Min" or "1Hour". -Cryptocurrency +Cryptocurrency -------- .. code-block:: python # You can obtain cryptocurrency metadata using the following method. # NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list! - + client.get_crypto_metadata(['BTCUSD'], fmt='json') #You can obtain top-of-book cryptocurrency quotes from the ``get_crypto_top_of_book()`` method. # NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list! - + crypto_price = client.get_crypto_top_of_book(['BTCUSD'])`` # You can obtain historical Cryptocurrency price quotes from the get_crypto_price_history() method. # NOTE: Crypto symbol MUST be encapsulated in brackets as a Python list! - - client.get_crypto_price_history(tickers = ['BTCUSD'], startDate='2020-12-2', + + client.get_crypto_price_history(tickers = ['BTCUSD'], startDate='2020-12-2', endDate='2020-12-3', resampleFreq='1Hour') @@ -186,20 +186,20 @@ Websockets Support .. code-block:: python from tiingo import TiingoWebsocketClient - + def cb_fn(msg): - # Example response + # Example response # msg = { - # "service":"iex" # An identifier telling you this is IEX data. + # "service":"iex" # An identifier telling you this is IEX data. # The value returned by this will correspond to the endpoint argument. - # + # # # Will always return "A" meaning new price quotes. There are also H type Heartbeat msgs used to keep the connection alive # "messageType":"A" # A value telling you what kind of data packet this is from our IEX feed. - # + # # # see https://api.tiingo.com/documentation/websockets/iex > Response for more info # "data":[] # an array containing trade information and a timestamp - # + # # } print(msg) @@ -208,14 +208,14 @@ Websockets Support 'eventName':'subscribe', 'authorization':'API_KEY_GOES_HERE', #see https://api.tiingo.com/documentation/websockets/iex > Request for more info - 'eventData': { + 'eventData': { 'thresholdLevel':5 } } - + # any logic should be implemented in the callback function (cb_fn) TiingoWebsocketClient(subscribe,endpoint="iex",on_msg_cb=cb_fn) - + Further Docs From 99115ef317349ac109c9320e66db73bfd38d76df Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Sat, 25 May 2024 20:32:19 -0400 Subject: [PATCH 2/4] docs: add mentions for fundamentals data --- HISTORY.rst | 2 +- README.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/HISTORY.rst b/HISTORY.rst index 85b6341..f18850c 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -29,7 +29,7 @@ History 0.12.0 (2019-10-20) -------------------- -* Feature: Added 3 new methods for crypo endpoints: top of book prices, historical, and metadata endpoints (@n1rna #340) +* Feature: Added 3 new methods for crypto endpoints: top of book prices, historical, and metadata endpoints (@n1rna #340) * Feature: Permit list_tickers to support multiple asset types at once (@n1rna #346) 0.11.0 (2019-09-01) diff --git a/README.rst b/README.rst index 7f00e49..9701913 100644 --- a/README.rst +++ b/README.rst @@ -27,6 +27,7 @@ Tiingo is a financial data platform making high quality financial tools availabl * Stock Market Ticker Closing Prices + Metadata. Data includes full distribution details and is validated using a proprietary EOD Price Engine. * Curated news from top financial news sources + blogs. Stories are tagged with topic tags and relevant stock tickers by Tiingo's algorithms. +* Fundamentals data, including definitions, daily data, and quarterly statements for tickers Usage From e6d86e7b8b05f31f556fa7d188ffcef1c3af5d03 Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Sat, 25 May 2024 20:40:22 -0400 Subject: [PATCH 3/4] finish updating changelog with non-bot PR titles --- HISTORY.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index f18850c..9d03d60 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -7,9 +7,12 @@ History 0.15.0 (2024-05-25) -------------------------------- +* Feature: Support websockets client / endpoints (#508) * Documentation: Add crypto endpoint examples (#621) -* Development: Code is formatted with black: (#663) -* CI: No longer testing Python versions older than 3.10 (#944) +* Development: Code is formatted with black (#663) +* CI: Stopped testing Python versions older than 3.10 (#944) +* CI: fixed CodeCov upload (#856) +* CI: Add CodeQL for static analysis scanning (#785) * Minor: bumped development / examples dependencies 0.14.0 (2021-03-06) From 5a65a18e2f6612afe91b9fc0f8ce012a45ed8e29 Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Sat, 25 May 2024 20:44:15 -0400 Subject: [PATCH 4/4] build: bump version string to 0.15.0 --- tiingo/__version__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tiingo/__version__.py b/tiingo/__version__.py index 2fbb3d1..9eeeaaa 100644 --- a/tiingo/__version__.py +++ b/tiingo/__version__.py @@ -1,2 +1,2 @@ # -*- coding: utf-8 -*- -__version__ = "0.14.0" +__version__ = "0.15.0"