pikudhaoref.py 0.0.4

An API wrapper for Pikud Haoref's rocket API.

PikudHaoref.py

Documentation

An unofficial API wrapper for Pikud Haoref's rocket API written in python.

The documentation is not done yet.

Features

• Very easy to use and user friendly.
• Object Oriented.
• Detect sirens in real time. (MORE COMING SOON)

The pikudhaoref API is only accessible from Israel.

Installation

Installing pikudhaoref.py is very easy.

python -m pip install pikudhaoref.py

Examples

Siren detector example

import pikudhaoref


client = pikudhaoref.Client(update_interval=2)
print(client.history())  # client.history returns sirens that happened in the last 24 hours.
print(client.get_current_sirens())  # Returns the current sirens


@client.event()
def on_siren(sirens):
    print(f"Siren alert! started sirens: {sirens}")


@client.event()
def on_siren_end(sirens):
    print(f"Sirens {sirens} have ended.")

TODO

• None

Known Issues

• Currently, None!

Incase you do find bugs, please create an issue or a PR.

Support

• Documentation