Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
remi-dupre committed Feb 3, 2025
1 parent 5b3ef35 commit ab25810
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,20 @@ Tests can be run by running `cargo test`.
A fuzzing can be run using _cargo-fuzz_ by running
`cargo +nightly fuzz run -j 4 parse_oh`.

### Re-generating Python stub file

_opening_hours.pyi_ should not be edited manually, if you make changes to
Python bindings, you need to update it automatically:

```bash
# Install required dev dependencies
poetry install --with dev

# Generate stub file
cd opening-hours-py
cargo run --bin stub_gen
```

[codecov]: https://app.codecov.io/gh/remi-dupre/opening-hours-rs "Code coverage"
[crate-log]: https://crates.io/crates/log "crates.io page for 'log'"
[docs]: https://docs.rs/opening-hours "Documentation"
Expand All @@ -89,4 +103,3 @@ A fuzzing can be run using _cargo-fuzz_ by running
[opening-hours]: https://crates.io/crates/opening-hours "Package"
[opening-hours-syntax]: https://crates.io/crates/opening-hours-syntax "Syntax Package"
[pypy]: https://pypi.org/project/opening-hours-py "Python package"
[workalendar]: https://pypi.org/project/workalendar/ "Worldwide holidays and working days helper and toolkit."
2 changes: 1 addition & 1 deletion opening-hours-py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ documentation [here](https://remi-dupre.github.io/opening-hours-rs/opening_hours
- 🧮 Evaluation of state and next change
- ⏳ Lazy infinite iterator
- 🌅 Accurate sun events
- 📅 Embedded public holidays database for many countries (from [nagger])
- 📅 Embedded public holidays database for many countries (from [nager])
- 🌍 Timezone support
- 🔥 Fast and memory-safe implementation using Rust

Expand Down

0 comments on commit ab25810

Please sign in to comment.