HijriDate
formerly hijri-converter
A Python package for accurate Hijri-Gregorian date conversion using the Umm al-Qura calendar.
HijriDate provides reliable date conversion based on official sources, including archived Umm al-Qura newspaper publications and comparative calendar data from King Abdulaziz City for Science and Technology (KACST). The package has been thoroughly tested and verified against original references to ensure accuracy and reliability.
✨ Features
- Accurate and verified Hijri-Gregorian date conversion
- Based on official Umm al-Qura calendar sources and archived publications
- Optimized performance compared to existing implementations
- Comprehensive input validation and error handling
- Multilingual support for Arabic, English, and other languages
- Rich comparison operations and date formatting options
- Full type annotations and 100% test coverage
- Zero runtime dependencies
⚠️ Limitations
Date Range: The converter supports dates from 1343 AH to 1500 AH (1 August 1924 CE to 16 November 2077 CE), corresponding to the period covered by available official calendar sources.
Religious Context: Not intended for religious purposes where lunar crescent sighting is preferred over astronomical calculations.
📦 Installation
To install using uv, run:
uv add hijridate
To install using pip, run:
pip install hijridate
To install using conda, run:
conda install conda-forge::hijridate
🚀 Basic Usage
from hijridate import Hijri, Gregorian
# Convert a Hijri date to Gregorian
hijri_date = Hijri(1445, 6, 15)
gregorian_date = hijri_date.to_gregorian()
print(gregorian_date) # 2023-12-28
# Convert a Gregorian date to Hijri
gregorian_date = Gregorian(2023, 12, 28)
hijri_date = gregorian_date.to_hijri()
print(hijri_date) # 1445-06-15
📚 Documentation
Please refer to https://hijridate.readthedocs.io for complete documentation on this package, which includes background information, benchmarking, usage examples, and API reference.
🤝 Contributing
If you’re interested in contributing, please check out the Contributing guide for more information on how you can help!
📄 License
This project is licensed under the terms of the MIT license.
🙏 Acknowledgements
- R.H. van Gent — inspiration, scientific guidance and resources.
- @AZalshehri7 — support in dates review and conversion accuracy verification.
📝 Citation
If you plan to cite this project in your academic publication, please refer to https://doi.org/10.5281/zenodo.11200950 for citation information.
评论