2 个版本
0.1.1 | 2024 年 1 月 1 日 |
---|---|
0.1.0 | 2024 年 1 月 1 日 |
#657 in 文本处理
41KB
685 行
基玛里亚-rs
Gematria-rs
是一个用于计算希伯来文本中基玛里亚值的 Rust 库。它支持多种计算方法,适用于分析像希伯来圣经这样的文本。该库包括一个命令行界面 (CLI),便于交互。
特性
- 多种基玛里亚计算方法:支持多种基玛里亚方法,如 Mispar Hechrechi、Mispar Gadol、Mispar Katan 等。
- 希伯来文本分析:适用于处理希伯来文本,包括处理元音符号(nikkud)。
- CLI 界面易于使用:用户友好的命令行界面,用于对文本执行基玛里亚计算。
- 文本文件处理:能够处理整个文本文件,并按基玛里亚值分组单词。
- 灵活的数据处理:设计用于处理不同元音符号的单词作为独特条目。
- 可定制:易于集成到更大的项目中,并根据特定的分析需求进行定制。
使用方法
作为库
通过运行以下命令将 Gematria-rs
包含到您的 Rust 项目中
cargo add gematria_rs
或在您的 Cargo.toml
中添加它
[dependencies]
gematria_rs = "0.1.1"
在项目中使用它
use gematria_rs::GematriaContext;
let gematria_context = GematriaContext::default();
let value = gematria_context.calculate_value("שלום");
println!("Gematria value: {}", value);
您可以使用
gematria_rs::GematriaBuilder
修改默认设置。
作为 CLI 工具
要使用 CLI 工具,请克隆仓库并构建项目
git clone https://github.com/MadBull1995/gematria-rs.git
cd gematria-rs
cargo build --release
运行 CLI
./target/release/gematria [COMMAND] [OPTIONS]
CLI
CLI 提供以下功能
- 计算基玛里亚值:计算给定希伯来单词或短语的基玛里亚值。
- 按基玛里亚值分组单词:分析文本文件,并根据其基玛里亚值分组单词。
使用 --help
查看所有可用命令和选项。
示例
您可以使用希伯来圣经的全文文件,位于
/data/hebrew-all.txt
从 stdin
中按“标准”基玛里亚值分组所有相同的单词
./target/release/gematria group-words < ./data/hebrew-all.txt
或从参数
./target/release/gematria group-words "נכנס יין יצא סוד"
# 70 -> יין, סוד
开发
设置开发环境
确保您已安装 Rust 和 Cargo。克隆仓库,您就可以开始为 Gematria-rs
做贡献。
运行测试
要运行测试,请使用
cargo test
构建文档
要在本地构建文档,包括用于Gematria方法解释的数学排版Katex
,请运行
RUSTDOCFLAGS="--html-in-header src/docs-header.html" cargo doc --no-deps --open
贡献
Gematria-rs
欢迎贡献!无论是改进文档、添加更多Gematria方法还是增强CLI工具,您的意见都很宝贵。
许可证
Gematria-rs
采用MIT许可证。
依赖
约1.2-1.7MB
约33K SLoC