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 using the Umm al-Qura calendar of Saudi Arabia.

Checks Status Coverage Status Code Quality 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 convert


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

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

Documentation

Please see https://dralshehri.github.io/hijri-converter/ 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

Any contribution is welcome! Refer to CONTRIBUTING.md for instructions and local development commands.

Authors

Authors and acknowledgments are listed in AUTHORS.md.

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.1.2.tar.gz (33.2 kB view hashes)

Uploaded Source

Built Distribution

hijri_converter-2.1.2-py3-none-any.whl (14.0 kB view hashes)

Uploaded Python 3

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