nautilus_system/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 Posei Systems Pty Ltd. All rights reserved.
3// https://poseitrader.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//! System-level components and orchestration for PoseiTrader.
17//!
18//! This crate provides the core system architecture for orchestrating trading systems,
19//! including the kernel that manages all engines, configuration management,
20//! and system-level factories for creating components.
21//!
22//! The main components include:
23//! - [`PoseiKernel`] - Core system orchestrator managing engines and components.
24//! - [`PoseiKernelConfig`] - Configuration for kernel initialization.
25//! - System builders and factories for component creation.
26//!
27//! [`PoseiKernel`]: kernel::PoseiKernel
28//!
29//! [PoseiTrader](http://poseitrader.io) is an open-source, high-performance, production-grade
30//! algorithmic trading platform, providing quantitative traders with the ability to backtest
31//! portfolios of automated trading strategies on historical data with an event-driven engine,
32//! and also deploy those same strategies live, with no code changes.
33//!
34//! # Feature flags
35//!
36//! This crate provides feature flags to control source code inclusion during compilation,
37//! depending on the intended use case, i.e. whether to provide Python bindings
38//! for the [posei_trader](https://pypi.org/project/posei_trader) Python package,
39//! or as part of a Rust only build.
40//!
41//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
42
43#![warn(rustc::all)]
44#![deny(unsafe_code)]
45#![deny(nonstandard_style)]
46#![deny(missing_debug_implementations)]
47#![deny(clippy::missing_errors_doc)]
48#![deny(clippy::missing_panics_doc)]
49#![deny(rustdoc::broken_intra_doc_links)]
50
51pub mod builder;
52pub mod config;
53pub mod factories;
54pub mod kernel;
55
56// Re-exports
57pub use config::PoseiKernelConfig;