hijri-datetime 0.0.0__tar.gz

hijri_datetime-0.0.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.1
+Name: hijri-datetime
+Version: 0.0.0
+Summary: Pythonic Hijri datetime — handle full & partial dates, ranges, and seamless Gregorian & Jalali conversion.
+Author-email: "m.lotfi" <m.lotfi@email.com>
+Maintainer-email: "m.lotfi" <m.lotfi@email.com>
+License: GPL version 3
+Project-URL: Homepage, https://github.com/mlotfic/hijri_datetime
+Project-URL: Documentation, https://github.com/mlotfic/hijri_datetime#readme
+Project-URL: Repository, https://github.com/mlotfic/hijri_datetime
+Project-URL: Bug Tracker, https://github.com/mlotfic/hijri_datetime/issues
+Project-URL: Changelog, https://github.com/mlotfic/hijri_datetime/blob/main/CHANGELOG.md
+Keywords: python,package,modules,portable,hijri,islamic,calendar,datetime
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jdatetime
+Requires-Dist: requests
+Requires-Dist: numpy
+Requires-Dist: pandas
+
+# hijri-datetime
+
+📅 **Hijri (Islamic) calendar datetime library for Python**  
+A drop-in replacement for Python's built-in `datetime` module, supporting Hijri date arithmetic, formatting, conversion, partial dates, and integration with `jdatetime`.
+
+---
+
+## Features
+
+- **HijriDate / HijriDateTime classes**  
+  Drop-in replacement for `datetime.date` and `datetime.datetime`.
+
+- **Partial Dates & Ranges**  
+  Handle missing months or days gracefully:
+  - `HijriDate(1446)` → represents the full year.
+  - `HijriDate(1446, 2)` → represents all days of month 2.
+  - Arithmetic supports ranges and comparisons.
+
+- **Gregorian ↔ Hijri Conversion**  
+  - Vectorized conversion using preloaded dataset (from [Aladhan API](https://aladhan.com/islamic-calendar-api)).
+  - Accurate conversion for historical and future dates.
+  
+- **Integration with jdatetime**  
+  Convert Hijri dates to Jalali calendar easily:
+  ```python
+  import jdatetime
+  jd = hijri_date.to_jdatetime()
+  ````
+
+* **Full datetime API support**
+  Methods like `.year`, `.month`, `.day`, `.weekday()`, `.isoweekday()`, `.strftime()`, `.fromisoformat()`, `.today()`, `.now()`.
+
+* **Calendar module compatibility**
+  Leap year checks, month lengths, weekdays, etc.
+
+* **Vectorized / Bulk Conversion Support**
+  Efficient for millions of rows with pandas/numpy.
+
+---
+
+## Installation
+
+```bash
+pip install hijri-datetime
+```
+
+---
+
+## Quick Start
+
+```python
+from hijri_datetime import HijriDate, HijriDateTime
+
+# Create Hijri dates
+d1 = HijriDate(1446, 2, 15)  # Full date
+d2 = HijriDate(1446, 2)      # Day missing → treat as range
+d3 = HijriDate(1446)         # Month & day missing → full year range
+
+# Convert to Gregorian
+print(d1.to_gregorian())             # datetime.date(2025, 9, 9)
+print(d2.to_gregorian_range())       # [datetime.date(2025,9,1), datetime.date(2025,9,30)]
+print(d3.to_gregorian_range())       # full year range
+
+# Date arithmetic
+print(d1 + 10)   # Add 10 days
+print(d1 - 5)    # Subtract 5 days
+
+# jdatetime conversion
+import jdatetime
+jd = d1.to_jdatetime()
+print(jd)        # jdatetime.date(...)
+```
+
+---
+
+## Partial Dates & Ranges
+
+- `HijriDate(1446)` → represents the whole year.
+- `HijriDate(1446, 2)` → represents all days of month 2.
+- Conversion to Gregorian returns ranges:
+
+* **Year only**
+
+  ```python
+  d = HijriDate(1446)
+  start, end = d.to_gregorian_range()
+  print(start, end)  # 2024-07-18 2025-07-06 (example)
+  ```
+
+* **Year and Month only**
+
+  ```python
+  d = HijriDate(1446, 2)
+  start, end = d.to_gregorian_range()
+  print(start, end)  # 2025-09-01 2025-09-30 (example)
+  ```
+
+---
+
+## Gregorian ↔ Hijri Conversion
+
+```python
+from hijri_datetime import HijriConverter
+
+converter = HijriConverter()
+
+# Hijri → Gregorian
+greg = converter.hijri_to_gregorian(1446, 2, 15)
+print(greg)  # datetime.date(2025, 9, 9)
+
+# Gregorian → Hijri
+hijri = converter.gregorian_to_hijri(greg)
+print(hijri)  # HijriDate(1446, 2, 15)
+```
+
+---
+
+## jdatetime Integration
+
+```python
+from hijri_datetime import HijriDate
+
+d = HijriDate(1446, 2, 15)
+jd = d.to_jdatetime()
+print(jd)  # jdatetime.date(2025, 6, 16) example
+```
+
+---
+
+## Pandas / Vectorized Example
+
+```python
+import pandas as pd
+from hijri_datetime import HijriDate
+
+dates = pd.Series([HijriDate(1446, 1, 1), HijriDate(1446, 2, 10)])
+greg_dates = dates.apply(lambda x: x.to_gregorian())
+print(greg_dates)
+```
+
+---
+
+## Roadmap
+
+* [ ] Full `calendar` module API compatibility
+* [ ] Timezone-aware Hijri datetime
+* [ ] Support for Umm al-Qura, tabular, and other Hijri variants
+* [ ] Improved bulk conversion performance
+* [ ] PyPI release with automated dataset update from Aladhan API
+
+---
+
+## Contributing
+
+Pull requests are welcome! Please open an issue first to discuss major changes.
+Could you make sure tests pass before submitting PRs?
+
+---
+
+## License
+
+GNU License © 2025

hijri_datetime-0.0.0/README.md

@@ -0,0 +1,162 @@
+# hijri-datetime
+
+📅 **Hijri (Islamic) calendar datetime library for Python**  
+A drop-in replacement for Python's built-in `datetime` module, supporting Hijri date arithmetic, formatting, conversion, partial dates, and integration with `jdatetime`.
+
+---
+
+## Features
+
+- **HijriDate / HijriDateTime classes**  
+  Drop-in replacement for `datetime.date` and `datetime.datetime`.
+
+- **Partial Dates & Ranges**  
+  Handle missing months or days gracefully:
+  - `HijriDate(1446)` → represents the full year.
+  - `HijriDate(1446, 2)` → represents all days of month 2.
+  - Arithmetic supports ranges and comparisons.
+
+- **Gregorian ↔ Hijri Conversion**  
+  - Vectorized conversion using preloaded dataset (from [Aladhan API](https://aladhan.com/islamic-calendar-api)).
+  - Accurate conversion for historical and future dates.
+  
+- **Integration with jdatetime**  
+  Convert Hijri dates to Jalali calendar easily:
+  ```python
+  import jdatetime
+  jd = hijri_date.to_jdatetime()
+  ````
+
+* **Full datetime API support**
+  Methods like `.year`, `.month`, `.day`, `.weekday()`, `.isoweekday()`, `.strftime()`, `.fromisoformat()`, `.today()`, `.now()`.
+
+* **Calendar module compatibility**
+  Leap year checks, month lengths, weekdays, etc.
+
+* **Vectorized / Bulk Conversion Support**
+  Efficient for millions of rows with pandas/numpy.
+
+---
+
+## Installation
+
+```bash
+pip install hijri-datetime
+```
+
+---
+
+## Quick Start
+
+```python
+from hijri_datetime import HijriDate, HijriDateTime
+
+# Create Hijri dates
+d1 = HijriDate(1446, 2, 15)  # Full date
+d2 = HijriDate(1446, 2)      # Day missing → treat as range
+d3 = HijriDate(1446)         # Month & day missing → full year range
+
+# Convert to Gregorian
+print(d1.to_gregorian())             # datetime.date(2025, 9, 9)
+print(d2.to_gregorian_range())       # [datetime.date(2025,9,1), datetime.date(2025,9,30)]
+print(d3.to_gregorian_range())       # full year range
+
+# Date arithmetic
+print(d1 + 10)   # Add 10 days
+print(d1 - 5)    # Subtract 5 days
+
+# jdatetime conversion
+import jdatetime
+jd = d1.to_jdatetime()
+print(jd)        # jdatetime.date(...)
+```
+
+---
+
+## Partial Dates & Ranges
+
+- `HijriDate(1446)` → represents the whole year.
+- `HijriDate(1446, 2)` → represents all days of month 2.
+- Conversion to Gregorian returns ranges:
+
+* **Year only**
+
+  ```python
+  d = HijriDate(1446)
+  start, end = d.to_gregorian_range()
+  print(start, end)  # 2024-07-18 2025-07-06 (example)
+  ```
+
+* **Year and Month only**
+
+  ```python
+  d = HijriDate(1446, 2)
+  start, end = d.to_gregorian_range()
+  print(start, end)  # 2025-09-01 2025-09-30 (example)
+  ```
+
+---
+
+## Gregorian ↔ Hijri Conversion
+
+```python
+from hijri_datetime import HijriConverter
+
+converter = HijriConverter()
+
+# Hijri → Gregorian
+greg = converter.hijri_to_gregorian(1446, 2, 15)
+print(greg)  # datetime.date(2025, 9, 9)
+
+# Gregorian → Hijri
+hijri = converter.gregorian_to_hijri(greg)
+print(hijri)  # HijriDate(1446, 2, 15)
+```
+
+---
+
+## jdatetime Integration
+
+```python
+from hijri_datetime import HijriDate
+
+d = HijriDate(1446, 2, 15)
+jd = d.to_jdatetime()
+print(jd)  # jdatetime.date(2025, 6, 16) example
+```
+
+---
+
+## Pandas / Vectorized Example
+
+```python
+import pandas as pd
+from hijri_datetime import HijriDate
+
+dates = pd.Series([HijriDate(1446, 1, 1), HijriDate(1446, 2, 10)])
+greg_dates = dates.apply(lambda x: x.to_gregorian())
+print(greg_dates)
+```
+
+---
+
+## Roadmap
+
+* [ ] Full `calendar` module API compatibility
+* [ ] Timezone-aware Hijri datetime
+* [ ] Support for Umm al-Qura, tabular, and other Hijri variants
+* [ ] Improved bulk conversion performance
+* [ ] PyPI release with automated dataset update from Aladhan API
+
+---
+
+## Contributing
+
+Pull requests are welcome! Please open an issue first to discuss major changes.
+Could you make sure tests pass before submitting PRs?
+
+---
+
+## License
+
+GNU License © 2025

hijri_datetime-0.0.0/pyproject.toml

@@ -0,0 +1,84 @@
+# -----------------------------
+# Build System (required)
+# -----------------------------
+[build-system]
+requires = ["setuptools<77", "wheel", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+# -----------------------------
+# Project Metadata
+# -----------------------------
+[project]
+name = "hijri-datetime" # PyPI/package install name (`pip install hijri_datetime`)
+# version = "2025.0.0"
+dynamic = ["version"]
+requires-python = ">=3.8"
+authors = [
+    { name = "m.lotfi", email = "m.lotfi@email.com" },
+]
+maintainers = [
+    { name = "m.lotfi", email = "m.lotfi@email.com" },
+]
+description = "Pythonic Hijri datetime — handle full & partial dates, ranges, and seamless Gregorian & Jalali conversion."
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "GPL version 3" }  # old-style, accepted
+
+keywords = [
+    "python", "package", "modules", "portable",
+    "hijri", "islamic", "calendar", "datetime"
+]
+
+# Classifiers help PyPI categorize your package
+classifiers = [
+    # How mature is this project? Common values are
+    #   3 - Alpha
+    #   4 - Beta
+    #   5 - Production/Stable
+    "Development Status :: 4 - Beta",
+
+    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+
+    # Indicate who your project is intended for
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+
+    # Specify the Python versions you support here.
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+# -----------------------------
+# Runtime dependencies
+# -----------------------------
+dependencies = [
+    "jdatetime",
+    "requests",
+    "numpy",
+    "pandas"
+]
+# -----------------------------
+# Project URLs (for PyPI & docs)
+# -----------------------------
+[project.urls]
+Homepage = "https://github.com/mlotfic/hijri_datetime"
+Documentation = "https://github.com/mlotfic/hijri_datetime#readme"
+Repository = "https://github.com/mlotfic/hijri_datetime"
+"Bug Tracker" = "https://github.com/mlotfic/hijri_datetime/issues"
+Changelog = "https://github.com/mlotfic/hijri_datetime/blob/main/CHANGELOG.md"
+
+
+
+# -----------------------------
+# setuptools config
+# -----------------------------
+[tool.setuptools.packages.find]
+where = ["src"]

hijri_datetime-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hijri_datetime-0.0.0/src/hijri_datetime/__init__.py

@@ -0,0 +1,3 @@
+from .hello import say_hello
+
+__all__ = ["say_hello"]

hijri_datetime-0.0.0/src/hijri_datetime/hello.py

@@ -0,0 +1,2 @@
+def say_hello(name: str) -> str:
+    return f"Hello, {name}!"

hijri_datetime-0.0.0/src/hijri_datetime.egg-info/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.1
+Name: hijri-datetime
+Version: 0.0.0
+Summary: Pythonic Hijri datetime — handle full & partial dates, ranges, and seamless Gregorian & Jalali conversion.
+Author-email: "m.lotfi" <m.lotfi@email.com>
+Maintainer-email: "m.lotfi" <m.lotfi@email.com>
+License: GPL version 3
+Project-URL: Homepage, https://github.com/mlotfic/hijri_datetime
+Project-URL: Documentation, https://github.com/mlotfic/hijri_datetime#readme
+Project-URL: Repository, https://github.com/mlotfic/hijri_datetime
+Project-URL: Bug Tracker, https://github.com/mlotfic/hijri_datetime/issues
+Project-URL: Changelog, https://github.com/mlotfic/hijri_datetime/blob/main/CHANGELOG.md
+Keywords: python,package,modules,portable,hijri,islamic,calendar,datetime
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jdatetime
+Requires-Dist: requests
+Requires-Dist: numpy
+Requires-Dist: pandas
+
+# hijri-datetime
+
+📅 **Hijri (Islamic) calendar datetime library for Python**  
+A drop-in replacement for Python's built-in `datetime` module, supporting Hijri date arithmetic, formatting, conversion, partial dates, and integration with `jdatetime`.
+
+---
+
+## Features
+
+- **HijriDate / HijriDateTime classes**  
+  Drop-in replacement for `datetime.date` and `datetime.datetime`.
+
+- **Partial Dates & Ranges**  
+  Handle missing months or days gracefully:
+  - `HijriDate(1446)` → represents the full year.
+  - `HijriDate(1446, 2)` → represents all days of month 2.
+  - Arithmetic supports ranges and comparisons.
+
+- **Gregorian ↔ Hijri Conversion**  
+  - Vectorized conversion using preloaded dataset (from [Aladhan API](https://aladhan.com/islamic-calendar-api)).
+  - Accurate conversion for historical and future dates.
+  
+- **Integration with jdatetime**  
+  Convert Hijri dates to Jalali calendar easily:
+  ```python
+  import jdatetime
+  jd = hijri_date.to_jdatetime()
+  ````
+
+* **Full datetime API support**
+  Methods like `.year`, `.month`, `.day`, `.weekday()`, `.isoweekday()`, `.strftime()`, `.fromisoformat()`, `.today()`, `.now()`.
+
+* **Calendar module compatibility**
+  Leap year checks, month lengths, weekdays, etc.
+
+* **Vectorized / Bulk Conversion Support**
+  Efficient for millions of rows with pandas/numpy.
+
+---
+
+## Installation
+
+```bash
+pip install hijri-datetime
+```
+
+---
+
+## Quick Start
+
+```python
+from hijri_datetime import HijriDate, HijriDateTime
+
+# Create Hijri dates
+d1 = HijriDate(1446, 2, 15)  # Full date
+d2 = HijriDate(1446, 2)      # Day missing → treat as range
+d3 = HijriDate(1446)         # Month & day missing → full year range
+
+# Convert to Gregorian
+print(d1.to_gregorian())             # datetime.date(2025, 9, 9)
+print(d2.to_gregorian_range())       # [datetime.date(2025,9,1), datetime.date(2025,9,30)]
+print(d3.to_gregorian_range())       # full year range
+
+# Date arithmetic
+print(d1 + 10)   # Add 10 days
+print(d1 - 5)    # Subtract 5 days
+
+# jdatetime conversion
+import jdatetime
+jd = d1.to_jdatetime()
+print(jd)        # jdatetime.date(...)
+```
+
+---
+
+## Partial Dates & Ranges
+
+- `HijriDate(1446)` → represents the whole year.
+- `HijriDate(1446, 2)` → represents all days of month 2.
+- Conversion to Gregorian returns ranges:
+
+* **Year only**
+
+  ```python
+  d = HijriDate(1446)
+  start, end = d.to_gregorian_range()
+  print(start, end)  # 2024-07-18 2025-07-06 (example)
+  ```
+
+* **Year and Month only**
+
+  ```python
+  d = HijriDate(1446, 2)
+  start, end = d.to_gregorian_range()
+  print(start, end)  # 2025-09-01 2025-09-30 (example)
+  ```
+
+---
+
+## Gregorian ↔ Hijri Conversion
+
+```python
+from hijri_datetime import HijriConverter
+
+converter = HijriConverter()
+
+# Hijri → Gregorian
+greg = converter.hijri_to_gregorian(1446, 2, 15)
+print(greg)  # datetime.date(2025, 9, 9)
+
+# Gregorian → Hijri
+hijri = converter.gregorian_to_hijri(greg)
+print(hijri)  # HijriDate(1446, 2, 15)
+```
+
+---
+
+## jdatetime Integration
+
+```python
+from hijri_datetime import HijriDate
+
+d = HijriDate(1446, 2, 15)
+jd = d.to_jdatetime()
+print(jd)  # jdatetime.date(2025, 6, 16) example
+```
+
+---
+
+## Pandas / Vectorized Example
+
+```python
+import pandas as pd
+from hijri_datetime import HijriDate
+
+dates = pd.Series([HijriDate(1446, 1, 1), HijriDate(1446, 2, 10)])
+greg_dates = dates.apply(lambda x: x.to_gregorian())
+print(greg_dates)
+```
+
+---
+
+## Roadmap
+
+* [ ] Full `calendar` module API compatibility
+* [ ] Timezone-aware Hijri datetime
+* [ ] Support for Umm al-Qura, tabular, and other Hijri variants
+* [ ] Improved bulk conversion performance
+* [ ] PyPI release with automated dataset update from Aladhan API
+
+---
+
+## Contributing
+
+Pull requests are welcome! Please open an issue first to discuss major changes.
+Could you make sure tests pass before submitting PRs?
+
+---
+
+## License
+
+GNU License © 2025

hijri_datetime-0.0.0/src/hijri_datetime.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+src/hijri_datetime/__init__.py
+src/hijri_datetime/calendar.py
+src/hijri_datetime/conversion.py
+src/hijri_datetime/date.py
+src/hijri_datetime/datetime.py
+src/hijri_datetime/hello.py
+src/hijri_datetime/range.py
+src/hijri_datetime/utils.py
+src/hijri_datetime.egg-info/PKG-INFO
+src/hijri_datetime.egg-info/SOURCES.txt
+src/hijri_datetime.egg-info/dependency_links.txt
+src/hijri_datetime.egg-info/requires.txt
+src/hijri_datetime.egg-info/top_level.txt
+tests/test_hello.py

hijri_datetime-0.0.0/src/hijri_datetime.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hijri_datetime-0.0.0/src/hijri_datetime.egg-info/requires.txt

@@ -0,0 +1,4 @@
+jdatetime
+requests
+numpy
+pandas

hijri_datetime-0.0.0/src/hijri_datetime.egg-info/top_level.txt

@@ -0,0 +1 @@
+hijri_datetime

hijri_datetime-0.0.0/tests/test_hello.py

@@ -0,0 +1,4 @@
+from hijri_datetime import say_hello
+
+def test_say_hello():
+    assert say_hello("World") == "Hello, World!"