magnus167/msyrs
1
0
Fork 0
mirror of https://github.com/Magnus167/msyrs.git synced 2025-11-19 22:06:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

update documentation and organization of the msyrs Rust library

Browse Source
This commit is contained in:
Palash Tyagi
2024-11-18 01:03:03 +00:00
parent 213ea72b20
commit b72a9b3441
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
src/lib.rs
View File

@@ -1,14 +1,29 @@
#![doc = include_str!("../README.md")] // #![doc = include_str!("../README.md")]
//! # msyrs
//!
//! A Rust implementation of the [Macrosynergy Python Package](https://github.com/macrosynergy/macrosynergy).
//!
//! ## Build and install the Python package
//!
//! ```bash
//! python -m venv .venv
//! # source .venv/bin/activate
//! ./.venv/Scripts/activate
//! pip install maturin
//! maturin develop --release
//! ```
//!
/// Documentation for the `msyrs` Python API. /// Documentation for the `msyrs` Python API.
pub mod py; pub mod py;
/// Documentation for the Rust API.
/// Documentation for the `download` module. /// Documentation for the `download` module.
pub mod download; pub mod download;
/// Documentation for the `utils` module.
pub mod utils; pub mod utils;
/// PyO3 bindings for the `msyrs` Python API.
pub use py::msyrs; #[allow(unused_imports)]
use py::msyrs;