Quickstart

Install JewCal using pip:

pip install jewcal

Run in the console:

jewcal

The output:

Today is 23 Iyar 5784

today.has_events()=True
today.is_erev()=True
today.is_erev_shabbos()=True
today.is_shabbos()=False
today.is_erev_yomtov()=False
today.is_yomtov()=False
today.is_issur_melacha()=False

JewCal(
  jewish_date=JewishDate(
    year=5784, month=2, day=23,
    gregorian_date=datetime.date(2024, 5, 31)
  ),
  events=Events(
    shabbos='Erev Shabbos',
    yomtov=None,
    action='Candles'
  ),
  diaspora=True,
  zmanim=None
)


Zmanim for Jerushalayim:
{
  'hadlokas_haneiros': '2024-05-31T15:59:12.468117+00:00',
  'plag_hamincha': '2024-05-31T15:11:15.201081+00:00',
  'sunrise': '2024-05-31T02:34:50.704559+00:00',
  'sunset': '2024-05-31T16:39:12.468117+00:00',
  'tzeis_hakochavim': '2024-05-31T17:21:11.859783+00:00',
  'tzeis_minutes': '2024-05-31T17:51:12.468117+00:00'
}

Location(
  latitude=31.76904, longitude=35.21633,
  use_tzeis_hakochavim=True,
  hadlokas_haneiros_minutes=40,
  tzeis_minutes=72
)

The code:

"""JewCal quickstart.

This script can be invoked from the command line:
    `jewcal`
"""

from pprint import pprint

from jewcal import JewCal
from jewcal.models.zmanim import Location


def main() -> None:
    """Run a simple example."""
    today = JewCal()

    print(f'Today is {today.jewish_date!s}', end='\n\n')

    print(f'{today.has_events()=}')
    print(f'{today.is_erev()=}')
    print(f'{today.is_erev_shabbos()=}')
    print(f'{today.is_shabbos()=}')
    print(f'{today.is_erev_yomtov()=}')
    print(f'{today.is_yomtov()=}')
    print(f'{today.is_issur_melacha()=}')

    print(f'\n{today!r}')

    print('\n\nZmanim for Jerushalayim:')
    location = Location(
        latitude=31.76904,
        longitude=35.21633,
        use_tzeis_hakochavim=False,
        hadlokas_haneiros_minutes=40,
        tzeis_minutes=72,
    )

    jewcal = JewCal(diaspora=False, location=location)
    if zmanim := jewcal.zmanim:
        pprint(zmanim.to_dict())

    print(f'\n{location}')


if __name__ == '__main__':  # pragma: no cover
    main()