Skip to main content

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

Project description

Hijri Converter

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

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

Features

  • Accurate and tested 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 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

pip install -U 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.

Acknowledgements

  • R.H. van Gent — inspiration, scientific guidance and resources.
  • @AZalshehri7 — support in dates review and conversion validation.

License

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

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.2.0.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

hijri_converter-2.2.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hijri-converter-2.2.0.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for hijri-converter-2.2.0.tar.gz
Algorithm Hash digest
SHA256 db9a5f31c884254163af6a1c39be81c807a5e897ba9587624d6706dd1048f160
MD5 8fe8691026c48935f2705867f59ba3b8
BLAKE2b-256 d97f103c6e535987ffd3283c026e6e9f09bf5c25a90bcca3f3b3bd37df42583d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hijri_converter-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for hijri_converter-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8a224c3227547e23f2931a2a6fca4d04c2ebb64a1ff626f754353f2fa08070e
MD5 3a57385aadd7385e411d081fc5cd69d5
BLAKE2b-256 f9171b7314a44dd60b032ed0939112c4dfadfa715ab248d986e8006e090feb39

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