nautilus_tardis/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! [NautilusTrader](https://nautilustrader.io) adapter for [Tardis](https://tardis.dev).
17//!
18//! The `nautilus-tardis` crate combines Tardis instrument metadata, normalized Tardis Machine streams,
19//! and CSV loaders for cryptocurrency market data across exchanges. It supports live data collection,
20//! historical replay, and Parquet catalog generation, with optional Python bindings.
21//!
22//! The official Tardis API reference can be found at <https://docs.tardis.dev/>.
23//!
24//! # NautilusTrader
25//!
26//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native trading engine
27//! with a deterministic, event-driven architecture for multi-asset, multi-venue systems.
28//!
29//! The system spans research, simulation, and live execution, providing research-to-live semantic parity.
30//!
31//! # Feature Flags
32//!
33//! Feature flags control code inclusion for Rust builds and Python bindings:
34//!
35//! - `arrow`: Enables Apache Arrow and Parquet data support.
36//! - `examples`: Enables the crate's example binaries.
37//! - `extension-module`: Builds as a Python extension module.
38//! - `high-precision` (default): Enables
39//! [high-precision mode](https://nautilustrader.io/docs/nightly/getting_started/installation/#precision-mode)
40//! to use 128-bit value types.
41//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
42//! - `replay`: Enables market data replay functionality (implies `arrow`).
43//!
44//! # Documentation
45//!
46//! - [Integration guide](https://nautilustrader.io/docs/nightly/integrations/tardis/)
47//! - [Rust examples](https://github.com/nautechsystems/nautilus_trader/tree/develop/crates/adapters/tardis/examples)
48//! - [Python examples](https://github.com/nautechsystems/nautilus_trader/tree/develop/examples/live/tardis)
49
50#![warn(rustc::all)]
51#![deny(unsafe_code)]
52#![deny(nonstandard_style)]
53#![deny(missing_debug_implementations)]
54#![deny(clippy::missing_errors_doc)]
55#![deny(clippy::missing_panics_doc)]
56#![deny(rustdoc::broken_intra_doc_links)]
57
58pub mod common;
59pub mod config;
60pub mod csv;
61pub mod data;
62pub mod factories;
63pub mod http;
64pub mod machine;
65
66#[cfg(feature = "python")]
67pub mod python;
68
69#[cfg(feature = "replay")]
70pub mod replay;