kosher-rust

Rust port of KosherJava: Jewish holidays, zmanim for your location, and daily learning schedules like Daf Yomi and Pirkei Avos.

Documentation

Examples and API reference: docs.rs/kosher-rust.

Installation

cargo add kosher-rust jiff

Features

• alloc (default) — Zman preset descriptions; without it the crate stays no_std and calculation APIs are unchanged
• defmt — defmt::Format on calculator, config, location, and error types

License

Licensed under the GNU Lesser General Public License v2.1 — see LICENSE.

Acknowledgments

This project is based on the KosherJava project by Eliyahu Hershfeld.

Maintainence

To update the project to the latest version of KosherJava, run the following command:

git subtree pull  --prefix=third-party/kosher-java  https://github.com/KosherJava/zmanim master  --squash

Then add the zmanim definitions to /tools/dsl.py and run tools/generate-rust.py to update the Rust code. In some instances, you may need to add features to the DSL to support the new zmanim. Updates to preset documentation should be made in /tools/dsl.py as well.

We are currently tracking commit c44b0bd of KosherJava.

TODOs

There are some parts of KosherJava which have not been ported to Rust yet.
These may happen someday or never. If you need them, please open an issue and we'll see what we can do.

• JewishCalendar.getTekufa
• JewishCalendar.getTekufaAsInstant
• ZmanimFormatter
• TefilaRules
• HebrewDateFormatter