nautilus_sandbox/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](http://nautilustrader.io) sandbox execution adapter.
17//!
18//! The `nautilus-sandbox` crate provides a simulated execution client that uses
19//! the `OrderMatchingEngine` to simulate order execution against live market data.
20//! This enables paper trading and strategy testing in real-time without actual
21//! order execution on exchanges.
22//!
23//! # Platform
24//!
25//! [NautilusTrader](http://nautilustrader.io) is an open-source, high-performance, production-grade
26//! algorithmic trading platform, providing quantitative traders with the ability to backtest
27//! portfolios of automated trading strategies on historical data with an event-driven engine,
28//! and also deploy those same strategies live, with no code changes.
29//!
30//! # Feature Flags
31//!
32//! This crate provides feature flags to control source code inclusion during compilation,
33//! depending on the intended use case, i.e. whether to provide Python bindings
34//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
35//! or as part of a Rust only build.
36//!
37//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
38//! - `extension-module`: Builds as a Python extension module (used with `python`).
39
40#![warn(rustc::all)]
41#![deny(unsafe_code)]
42#![deny(nonstandard_style)]
43#![deny(missing_debug_implementations)]
44#![deny(clippy::missing_errors_doc)]
45#![deny(clippy::missing_panics_doc)]
46#![deny(rustdoc::broken_intra_doc_links)]
47
48pub mod config;
49pub mod execution;
50pub mod factory;
51
52#[cfg(feature = "python")]
53pub mod python;
54
55// Re-exports
56pub use crate::{
57 config::SandboxExecutionClientConfig, execution::SandboxExecutionClient,
58 factory::SandboxExecutionClientFactory,
59};