From fbde0795f2a5804ea7760accce5cb5a8e2aa2b2e Mon Sep 17 00:00:00 2001 From: Roberto Mesado Date: Mon, 24 Jun 2024 17:24:12 -0700 Subject: [PATCH] MOD: Update docs links throughout codebase --- README.md | 14 +++++++------- databento/common/dbnstore.py | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c1cbfea..0459704 100644 --- a/README.md +++ b/README.md @@ -10,18 +10,18 @@ The official Python client library for [Databento](https://databento.com). Key features include: -- Fast, lightweight access to both live and historical data from [multiple markets](https://databento.com/docs/knowledge-base/new-users/venues-and-publishers?historical=python&live=python). -- [Multiple schemas](https://databento.com/docs/knowledge-base/new-users/market-data-schemas?historical=python&live=python) such as MBO, MBP, top of book, OHLCV, last sale, and more. -- [Fully normalized](https://databento.com/docs/knowledge-base/new-users/normalization?historical=python&live=python), i.e. identical message schemas for both live and historical data, across multiple asset classes. +- Fast, lightweight access to both live and historical data from [multiple markets](https://databento.com/docs/faqs/venues-and-publishers). +- [Multiple schemas](https://databento.com/docs/schemas-and-data-formats/whats-a-schema?historical=python&live=python) such as MBO, MBP, top of book, OHLCV, last sale, and more. +- [Fully normalized](https://databento.com/docs/standards-and-conventions/normalization?historical=python&live=python), i.e. identical message schemas for both live and historical data, across multiple asset classes. - Provides mappings between different symbology systems, including [smart symbology](https://databento.com/docs/api-reference-historical/basics/symbology?historical=python&live=python) for futures rollovers. - [Point-in-time]() instrument definitions, free of look-ahead bias and retroactive adjustments. -- Reads and stores market data in an extremely efficient file format using [Databento Binary Encoding](https://databento.com/docs/knowledge-base/new-users/dbn-encoding?historical=python&live=python). +- Reads and stores market data in an extremely efficient file format using [Databento Binary Encoding](https://databento.com/docs/standards-and-conventions/databento-binary-encoding?historical=python&live=python). - Event-driven [market replay](https://databento.com/docs/api-reference-historical/helpers/bento-replay?historical=python&live=python), including at high-frequency order book granularity. -- Support for [batch download](https://databento.com/docs/knowledge-base/new-users/stream-vs-batch?historical=python&live=python) of flat files. +- Support for [batch download](https://databento.com/docs/faqs/streaming-vs-batch-download?historical=python&live=python) of flat files. - Support for [pandas](https://pandas.pydata.org/docs/), CSV, and JSON. ## Documentation -The best place to begin is with our [Getting started](https://databento.com/docs/getting-started?historical=python&live=python) guide. +The best place to begin is with our [Getting started](https://databento.com/docs/quickstart?historical=python&live=python) guide. You can find our full client API reference on the [Historical Reference](https://databento.com/docs/api-reference-historical?historical=python&live=python) and [Live Reference](https://databento.com/docs/reference-live?historical=python&live=python) sections of our documentation. See also the @@ -80,7 +80,7 @@ array = data.to_ndarray() # to ndarray ``` Note that the API key was also passed as a parameter, which is -[not recommended for production applications](https://databento.com/docs/knowledge-base/new-users/security-managing-api-keys?historical=python&live=python). +[not recommended for production applications](https://databento.com/docs/portal/api-keys?historical=python&live=python). Instead, you can leave out this parameter to pass your API key via the `DATABENTO_API_KEY` environment variable: ```python diff --git a/databento/common/dbnstore.py b/databento/common/dbnstore.py index 1e6358c..21011ab 100644 --- a/databento/common/dbnstore.py +++ b/databento/common/dbnstore.py @@ -330,7 +330,7 @@ class DBNStore: See Also -------- - https://databento.com/docs/knowledge-base/new-users/dbn-encoding + https://databento.com/docs/standards-and-conventions/databento-binary-encoding """