Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/remi-dupre/opening-hours-rs

A parser for the opening_hours fields from OpenStreetMap.
https://github.com/remi-dupre/opening-hours-rs

openstreetmap parser python3 rust

Last synced: 6 days ago
JSON representation

A parser for the opening_hours fields from OpenStreetMap.

Host: GitHub
URL: https://github.com/remi-dupre/opening-hours-rs
Owner: remi-dupre
License: apache-2.0
Created: 2020-05-30T18:08:07.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-12-27T09:08:22.000Z (13 days ago)
Last Synced: 2024-12-27T09:08:32.519Z (13 days ago)
Topics: openstreetmap, parser, python3, rust
Language: Rust
Homepage:
Size: 1.86 MB
Stars: 19
Watchers: 2
Forks: 6
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE

Awesome Lists containing this project

README

        # 🦀 Rust implementation for OSM Opening Hours

[![](https://img.shields.io/crates/v/opening-hours)][opening-hours]

[![](https://img.shields.io/pypi/v/opening-hours-py)][pypy]

[![](https://img.shields.io/docsrs/opening-hours)][docs]

[![](https://img.shields.io/crates/l/opening-hours)][opening-hours]

[![](https://img.shields.io/codecov/c/github/remi-dupre/opening-hours-rs)][codecov]

[![](https://img.shields.io/crates/d/opening-hours)][opening-hours]

**🐍 Python bindings can be found [here](https://github.com/remi-dupre/opening-hours-rs/tree/master/opening-hours-py)**

A Rust library for parsing and working with OSM's opening hours field. You can

find its specification [here][grammar] and the reference JS library

[here](https://github.com/opening-hours/opening_hours.js).

Note that the specification is quite messy and that the JS library takes

liberty to extend it quite a lot. This means that most of the real world data

don't actually comply to the very restrictive grammar detailed in the official

specification. This library tries to fit with the real world data while

remaining as close as possible to the core specification.

## Usage

Add this to your `Cargo.toml`:

```toml

[dependencies]

opening-hours = "0"

```

Here's a simple example that parse an opening hours description and displays

its current status and date for next change:

```rust

use chrono::Local;

use opening_hours::OpeningHours;

// Opens until 18pm during the week and until 12am the week-end.

const OH: &str = "Mo-Fr 10:00-18:00; Sa-Su 10:00-12:00";

fn main() {

    let oh: OpeningHours = OH.parse().unwrap();

    let date = Local::now().naive_local();

    println!("Current status is {:?}", oh.state(date));

    println!("This will change at {:?}", oh.next_change(date).unwrap());

}

```

## Supported features

### Holidays

A public holiday database is loaded using [nager]. You can refer to their

website for more detail on supported country or if you want to contribute.

If you enable the **auto-country** feature, you can automatically detect the

country of a point of interest from its coordinate.

### Syntax

If you are only interested in parsing expressions but not on the evaluation or

if you want to build your own evaluation engine, you should probably rely on

the [opening-hours-syntax] crate.

### Timezone

You can attach the timezone of the POI corresponding to your opening hours in

the evaluation context. If you enable the **auto-timezone** feature, you can

also automatically infer the timezone from coordinates.

### Logging

The **log** feature can be enabled to emit warnings the [crate-log] crate.

## Contributing

### Running tests

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`.

[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"

[grammar]: https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification "OSM specification for opening hours"

[nager]: https://date.nager.at/api/v3 "Worldwide holidays (REST API)"

[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."