nautilus_trading/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 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//! Trading strategy machinery and orchestration [NautilusTrader](http://nautilustrader.io).
17//!
18//! The `nautilus-trading` crate provides core trading capabilities including:
19//!
20//! - **Forex sessions**: Market session time calculations and timezone handling.
21//!
22//! # Platform
23//!
24//! [NautilusTrader](http://nautilustrader.io) is an open-source, high-performance, production-grade
25//! algorithmic trading platform, providing quantitative traders with the ability to backtest
26//! portfolios of automated trading strategies on historical data with an event-driven engine,
27//! and also deploy those same strategies live, with no code changes.
28//!
29//! NautilusTrader's design, architecture, and implementation philosophy prioritizes software correctness and safety at the
30//! highest level, with the aim of supporting mission-critical, trading system backtesting and live deployment workloads.
31//!
32//! # Feature flags
33//!
34//! This crate provides feature flags to control source code inclusion during compilation,
35//! depending on the intended use case, i.e. whether to provide Python bindings
36//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
37//! or as part of a Rust only build.
38//!
39//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
40//! - `extension-module`: Builds the crate as a Python extension module.
41
42#![warn(rustc::all)]
43#![deny(unsafe_code)]
44#![deny(nonstandard_style)]
45#![deny(missing_debug_implementations)]
46#![deny(clippy::missing_errors_doc)]
47#![deny(clippy::missing_panics_doc)]
48#![deny(rustdoc::broken_intra_doc_links)]
49
50pub mod sessions;
51
52#[cfg(feature = "python")]
53pub mod python;