Skip to main content

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

Project description

hijri-converter

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

⚠️ Deprecation Notice

This package has been deprecated and will not receive future updates. Please use the hijridate package instead.

For migration to hijridate, install the package:

pip install hijridate~=2.3.0

Then change the import statement as:

from hijridate import Hijri, Gregorian

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.7+ with zero dependencies.
  • Thoroughly tested with 100% test coverage.

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, run:

conda install -c conda-forge 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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hijri-converter-2.3.1.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

hijri_converter-2.3.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file hijri-converter-2.3.1.tar.gz.

File metadata

  • Download URL: hijri-converter-2.3.1.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for hijri-converter-2.3.1.tar.gz
Algorithm Hash digest
SHA256 069b6789291e0830f4860a79dcd34fb3ceea3b95516ed4010202b9656ba1ab61
MD5 2f9d38436b1e26b9d53c219e114dbbf3
BLAKE2b-256 8ecaf26e91818264caca15ba9ef71d99dea51c8391bf2818aabde278d9642441

See more details on using hashes here.

File details

Details for the file hijri_converter-2.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for hijri_converter-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c04f072c78e1854a1f474ada253a3377009457221dbc1b14999761728e663662
MD5 bc2ca2da6e7f19a3aec5eb62746c5577
BLAKE2b-256 4acf7bd8c3a8d1b8290cf11398439bcf30b9fb10dfe8247202edeaeea9cbdd5a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page