Skip to content

Accurate Hijri-Gregorian date converter based on the Umm al-Qura calendar

License

Notifications You must be signed in to change notification settings

impubes/hijri-converter

 
 

Repository files navigation

Hijri Converter

A Python package to convert accurately between Hijri and Gregorian dates based on the Umm al-Qura calendar.

Checks Status Coverage Status Code Quality Docs Status PyPI Downloads PyPI Version Conda Version Package License

Features

  • Accurate and verified date conversion.
  • Optimized code performance compared to similar packages.
  • Intuitive, clean, and easy-to-use interface.
  • Most of the methods and formats are similar to those of standard library.
  • Multilingual representation of weekday names, months, and calendar era notations.
  • Easily extendable to support other natural languages.
  • Rich comparison between dates.
  • Validation of input dates.
  • Works on Python 3.6+ with zero dependencies.
  • Thoroughly tested on all supported python versions.

Limitations

  • The date range supported by converter is limited to the period from the beginning of 1343 AH (1 August 1924 CE) to the end of 1500 AH (16 November 2077 CE).
  • The conversion is not intended for religious purposes where sighting of the lunar crescent at the beginning of Hijri month is still preferred.

Installation

To install using pip, run:

pip install hijri-converter

To install using conda, make sure the conda-forge channel is enabled, then run:

conda install hijri-converter

Basic Usage

from hijri_converter import Hijri, Gregorian


# Convert a Hijri date to Gregorian
g = Hijri(1403, 2, 17).to_gregorian()

# Convert a Gregorian date to Hijri
h = Gregorian(1982, 12, 2).to_hijri()

Documentation

Please see https://hijri-converter.readthedocs.io for full documentation of this package, including background, benchmarking, usage examples and API reference.

Changelog

All notable changes to this package are documented in CHANGELOG.md.

Contributing

Contributions are always welcome! See CONTRIBUTING.md for ways to get started.

License

This package is distributed under an MIT license. See LICENSE.

About

Accurate Hijri-Gregorian date converter based on the Umm al-Qura calendar

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%