Crates.io | gematria_rs |
lib.rs | gematria_rs |
version | 0.1.1 |
source | src |
created_at | 2024-01-01 12:17:41.247456 |
updated_at | 2024-01-01 13:01:07.727046 |
description | A rust implementation of the Gematria, a traditional Hebrew numerology system. |
homepage | |
repository | https://github.com/MadBull1995/gematria-rs |
max_upload_size | |
id | 1085305 |
size | 49,664 |
Gematria-rs
is a Rust library designed for calculating Gematria values in Hebrew texts. It supports multiple calculation methods and is suitable for analyzing texts like the Hebrew Bible. The library includes a command-line interface (CLI) for easy interaction.
Include Gematria-rs
in your Rust project by running:
cargo add gematria_rs
Or adding it to your Cargo.toml
:
[dependencies]
gematria_rs = "0.1.1"
Use it in your project:
use gematria_rs::GematriaContext;
let gematria_context = GematriaContext::default();
let value = gematria_context.calculate_value("שלום");
println!("Gematria value: {}", value);
You can use the
gematria_rs::GematriaBuilder
to change the default settings for the context easily.
To use the CLI tool, clone the repository and build the project:
git clone https://github.com/MadBull1995/gematria-rs.git
cd gematria-rs
cargo build --release
Run the CLI:
./target/release/gematria [COMMAND] [OPTIONS]
The CLI provides the following functionalities:
Use --help
to see all available commands and options.
You can use the full text file of the Hebrew Bible at
/data/hebrew-all.txt
Group all words that equals the same value in "Standard" gematria from stdin
:
./target/release/gematria group-words < ./data/hebrew-all.txt
Or from argument:
./target/release/gematria group-words "נכנס יין יצא סוד"
# 70 -> יין, סוד
Ensure you have Rust and Cargo installed. Clone the repository and you can start contributing to Gematria-rs
.
To run tests, use:
cargo test
To build the documentation locally, including the Katex
math typesetting for Gematria method explanations, run:
RUSTDOCFLAGS="--html-in-header src/docs-header.html" cargo doc --no-deps --open
Contributions to Gematria-rs
are welcome! Whether it's improving documentation, adding more Gematria methods, or enhancing the CLI tool, your input is valuable.
Gematria-rs
is licensed under MIT License.