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.

Build 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 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.2.4.tar.gz (34.9 kB view details)

Uploaded Source

Built Distribution

hijri_converter-2.2.4-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hijri-converter-2.2.4.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.13

File hashes

Hashes for hijri-converter-2.2.4.tar.gz
Algorithm Hash digest
SHA256 9e1d9fa4c220f6867da2abb1a96240675ae974abba951c686a781f4ef6ac218f
MD5 e7bc387a46f72ad2fc4e46daabf47dea
BLAKE2b-256 546f96f9880389a20057ce3fdfed70a9cea5eb47d679178a43c55f58a35d98be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hijri_converter-2.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5ed4f4c284626e3916cd770e09346d5cc319e2a7762c22357838864908fd6e6d
MD5 0504b8ed629db14b1ebed1cc78a17c6a
BLAKE2b-256 d926970069447a831bf0a36ea4673b04a2b4e24c8501b1334522226c9e152844

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