HijriDate

2.6.0 · active · verified Fri Apr 10

A Python package for accurate Hijri-Gregorian date conversion based on the Umm al-Qura calendar. It offers reliable date conversion, optimized performance, and multilingual support. The current version is 2.6.0 and it is actively maintained with a regular release cadence, including support for new Python versions.

Warnings

breaking The package was renamed from `hijri-converter` to `hijridate` in version 2.3.0.
Fix: Update your `pip install` command to `pip install hijridate` and modify all import statements from `from hijri_converter import ...` to `from hijridate import ...`.
breaking Support for Python 3.8 and 3.9 was dropped in `hijridate` v2.6.0. Python 3.7 support was dropped in v2.4.0, and Python 3.6 in v2.3.0.
Fix: Upgrade your Python environment to 3.10 or newer for `hijridate` versions 2.6.0 and above. For earlier `hijridate` versions, ensure you meet their specific Python requirements (e.g., Python 3.8+ for v2.5.0).
breaking The `validate` argument for `Hijri` and `Gregorian` object instantiation, and the `padding` argument for `dmyformat()` functions, became keyword-only arguments in v2.5.0.
Fix: When instantiating `Hijri` or `Gregorian` objects (e.g., `Hijri(1445, 6, 15, validate=True)`) or calling `dmyformat()` (e.g., `date_obj.dmyformat(padding=False)`), use keyword arguments for these parameters instead of positional ones.
breaking The `slashformat()` method was removed from `Hijri` and `Gregorian` classes in v2.2.0.
Fix: Replace calls to `date_obj.slashformat()` with `date_obj.dmyformat(separator='/')` to achieve the same formatting.
gotcha The converter supports dates only within the range 1343 AH to 1500 AH (1 August 1924 CE to 16 November 2077 CE) due to limitations of the official Umm al-Qura calendar sources. It is also not intended for religious purposes where lunar crescent sighting is preferred over astronomical calculations.
Fix: Users should be aware of the supported date range and the library's intended use. For dates outside this range or for religious sighting, alternative solutions may be required.

Install

pip install hijridate Install stable version

Imports

Hijri
```
from hijridate import Hijri
```
The package was renamed from `hijri-converter` to `hijridate` in v2.3.0.
Gregorian
```
from hijridate import Gregorian
```
The package was renamed from `hijri-converter` to `hijridate` in v2.3.0.

Quickstart

Initialize `Hijri` or `Gregorian` objects and use their `to_gregorian()` or `to_hijri()` methods for conversion. The `Hijri.today()` class method provides the current Hijri date.

from hijridate import Hijri, Gregorian

# Convert a Hijri date to Gregorian
hijri_date = Hijri(1445, 6, 15)
gregorian_date = hijri_date.to_gregorian()
print(f"Hijri {hijri_date} is Gregorian {gregorian_date}")

# Convert a Gregorian date to Hijri
gregorian_date = Gregorian(2023, 12, 28)
hijri_date_converted = gregorian_date.to_hijri()
print(f"Gregorian {gregorian_date} is Hijri {hijri_date_converted}")

# Get today's Hijri date
today_hijri = Hijri.today()
print(f"Today's Hijri date: {today_hijri}")

view raw JSON →