persiantools 3.0.0__tar.gz → 4.0.0__tar.gz

{persiantools-3.0.0 → persiantools-4.0.0}/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2016-2021 Majid Hajiloo
+Copyright (c) 2016-2024 Majid Hajiloo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{persiantools-3.0.0/persiantools.egg-info → persiantools-4.0.0}/PKG-INFO

@@ -1,24 +1,23 @@
 Metadata-Version: 2.1
 Name: persiantools
-Version: 3.0.0
+Version: 4.0.0
 Summary: Jalali date and datetime with other tools
 Home-page: https://github.com/majiidd/persiantools
 Author: Majid Hajiloo
 Author-email: majid.hajiloo@gmail.com
 License: MIT
 Keywords: jalali shamsi persian digits characters converter jalalidate jalalidatetime date datetime jdate jdatetime farsi
-Platform: UNKNOWN
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: Persian
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Software Development
@@ -26,9 +25,10 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Localization
 Classifier: Topic :: Utilities
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pytz
 
 # PersianTools
 
@@ -39,27 +39,25 @@ License-File: LICENSE
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/persiantools.svg)](https://pypi.org/project/persiantools/)
 [![PyPI - License](https://img.shields.io/pypi/l/persiantools.svg)](https://pypi.org/project/persiantools/)
 
-- Jalali (Shamsi) date and datetime (based on python datetime's module)
-
-  - Convert Jalali to Gregorian date/datetime and vice versa
-  - Support comparison and arithmetic operators such as `+`, `-`, `==`, `>=`
-  - Support timezone
-
-- Convert Arabic and Persian characters/digits to each other
-- Convert numbers to words
+Provides Jalali (also known as Shamsi or Persian) dates and datetimes functionalities, among other tools.
+- It converts between Jalali and Gregorian dates and datetimes (based on python datetime's module).
+- It supports operators like `+`, `-`, `==`, and `>=`.
+- It includes timezone support.
+- It converts between Arabic and Persian characters/digits.
+- It turns numbers into Persian words.
 
 ## Install Package
-
-```{.sourceCode .bash}
+You can install the package using pip with the following command:
+```bash
 python -m pip install persiantools
 ```
-Persiantools supports Python 3.6+. (_for python 2.7 and 3.5 use [1.5.x](https://github.com/majiidd/persiantools/tree/1.5.x) version_)
+Persiantools supports Python 3.8+. (_for python 2.7 and 3.5 use [1.5.x](https://github.com/majiidd/persiantools/tree/1.5.x) version_)
 
 ## How to use
 
 ### Date
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate
 >>> import datetime
 
@@ -84,7 +82,7 @@ JalaliDate(1367, 2, 14, Chaharshanbeh)
 
 ### Datetime
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDateTime
 >>> import datetime, pytz
 
@@ -108,7 +106,7 @@ JalaliDateTime(1395, 4, 17, 21, 23, 53, 474618, tzinfo=<UTC>)
 
 Based on python `strftime()` behavior
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate, JalaliDateTime
 >>> import pytz
 
@@ -127,7 +125,7 @@ Based on python `strftime()` behavior
 
 ### Digits/Characters Tools
 
-```{.sourceCode .python}
+```python
 >>> from persiantools import characters, digits
 
 >>> digits.en_to_fa("0987654321")
@@ -150,15 +148,15 @@ Based on python `strftime()` behavior
 ```
 
 ### Operators
-
-```{.sourceCode .python}
+The package supports various operators for date and time manipulations. Here are some examples:
+```python
 >>> from persiantools.jdatetime import JalaliDate, JalaliDateTime
 >>> import datetime
 
 >>> JalaliDate(1367, 2, 14) == JalaliDate(datetime.date(1988, 5, 4))
 True
 
->>> JalaliDateTime(1367, 2, 14, 4, 30) >= JalaliDateTime(1369, 7, 1, 1, 0)
+>>> JalaliDateTime(1367, 2, 14, 4, 30) >= JalaliDateTime(1368, 2, 14, 1, 0)
 False
 
 >>> JalaliDate(1367, 2, 14) == datetime.date(1988, 5, 4)
@@ -173,7 +171,7 @@ datetime.timedelta(365)
 
 ### Serializing and de-serializing
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate
 >>> import pickle
 
@@ -189,5 +187,3 @@ datetime.timedelta(365)
 >>> jalali
 JalaliDate(1367, 2, 14, Chaharshanbeh)
 ```
-
-

{persiantools-3.0.0 → persiantools-4.0.0}/README.md

@@ -7,27 +7,25 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/persiantools.svg)](https://pypi.org/project/persiantools/)
 [![PyPI - License](https://img.shields.io/pypi/l/persiantools.svg)](https://pypi.org/project/persiantools/)
 
-- Jalali (Shamsi) date and datetime (based on python datetime's module)
-
-  - Convert Jalali to Gregorian date/datetime and vice versa
-  - Support comparison and arithmetic operators such as `+`, `-`, `==`, `>=`
-  - Support timezone
-
-- Convert Arabic and Persian characters/digits to each other
-- Convert numbers to words
+Provides Jalali (also known as Shamsi or Persian) dates and datetimes functionalities, among other tools.
+- It converts between Jalali and Gregorian dates and datetimes (based on python datetime's module).
+- It supports operators like `+`, `-`, `==`, and `>=`.
+- It includes timezone support.
+- It converts between Arabic and Persian characters/digits.
+- It turns numbers into Persian words.
 
 ## Install Package
-
-```{.sourceCode .bash}
+You can install the package using pip with the following command:
+```bash
 python -m pip install persiantools
 ```
-Persiantools supports Python 3.6+. (_for python 2.7 and 3.5 use [1.5.x](https://github.com/majiidd/persiantools/tree/1.5.x) version_)
+Persiantools supports Python 3.8+. (_for python 2.7 and 3.5 use [1.5.x](https://github.com/majiidd/persiantools/tree/1.5.x) version_)
 
 ## How to use
 
 ### Date
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate
 >>> import datetime
 
@@ -52,7 +50,7 @@ JalaliDate(1367, 2, 14, Chaharshanbeh)
 
 ### Datetime
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDateTime
 >>> import datetime, pytz
 
@@ -76,7 +74,7 @@ JalaliDateTime(1395, 4, 17, 21, 23, 53, 474618, tzinfo=<UTC>)
 
 Based on python `strftime()` behavior
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate, JalaliDateTime
 >>> import pytz
 
@@ -95,7 +93,7 @@ Based on python `strftime()` behavior
 
 ### Digits/Characters Tools
 
-```{.sourceCode .python}
+```python
 >>> from persiantools import characters, digits
 
 >>> digits.en_to_fa("0987654321")
@@ -118,15 +116,15 @@ Based on python `strftime()` behavior
 ```
 
 ### Operators
-
-```{.sourceCode .python}
+The package supports various operators for date and time manipulations. Here are some examples:
+```python
 >>> from persiantools.jdatetime import JalaliDate, JalaliDateTime
 >>> import datetime
 
 >>> JalaliDate(1367, 2, 14) == JalaliDate(datetime.date(1988, 5, 4))
 True
 
->>> JalaliDateTime(1367, 2, 14, 4, 30) >= JalaliDateTime(1369, 7, 1, 1, 0)
+>>> JalaliDateTime(1367, 2, 14, 4, 30) >= JalaliDateTime(1368, 2, 14, 1, 0)
 False
 
 >>> JalaliDate(1367, 2, 14) == datetime.date(1988, 5, 4)
@@ -141,7 +139,7 @@ datetime.timedelta(365)
 
 ### Serializing and de-serializing
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate
 >>> import pickle
 

{persiantools-3.0.0 → persiantools-4.0.0}/persiantools/__init__.py

@@ -7,9 +7,9 @@
 
 __title__ = "persiantools"
 __url__ = "https://github.com/majiidd/persiantools"
-__version__ = "3.0.0"
+__version__ = "4.0.0"
 __build__ = __version__
 __author__ = "Majid Hajiloo"
 __author_email__ = "majid.hajiloo@gmail.com"
 __license__ = "MIT"
-__copyright__ = "Copyright (c) 2016-2022 Majid Hajiloo"
+__copyright__ = "Copyright (c) 2016-2024 Majid Hajiloo"

{persiantools-3.0.0 → persiantools-4.0.0}/persiantools/digits.py

@@ -1,4 +1,4 @@
-from persiantools import utils
+import re
 
 EN_TO_FA_MAP = {
     "0": "۰",
@@ -48,6 +48,12 @@ FA_TO_AR_MAP = {
     "۸": "٨",
     "۹": "٩",
 }
+
+EN_TO_FA_REGEX = re.compile("|".join(EN_TO_FA_MAP.keys()))
+AR_TO_FA_REGEX = re.compile("|".join(AR_TO_FA_MAP.keys()))
+FA_TO_EN_REGEX = re.compile("|".join(FA_TO_EN_MAP.keys()))
+FA_TO_AR_REGEX = re.compile("|".join(FA_TO_AR_MAP.keys()))
+
 ONES = ("یک", "دو", "سه", "چهار", "پنج", "شش", "هفت", "هشت", "نه")
 TENS = ("بیست", "سی", "چهل", "پنجاه", "شصت", "هفتاد", "هشتاد", "نود")
 HUNDREDS = ("یکصد", "دویست", "سیصد", "چهارصد", "پانصد", "ششصد", "هفتصد", "هشتصد", "نهصد")
@@ -80,7 +86,7 @@ DECISION = {
     1000: lambda n, depth: HUNDREDS[n // 100 - 1] + _to_word(n % 100, True),
     1000000: lambda n, depth: _to_word(n // 1000, depth) + BIG_RANGE[0] + _to_word(n % 1000, True),
     1000000000: lambda n, depth: _to_word(n // 1000000, depth) + BIG_RANGE[1] + _to_word(n % 1000000, True),
-    1000000000000: lambda n, depth: _to_word(n // n, depth) + BIG_RANGE[2] + _to_word(n % 1000000000, True),
+    1000000000000: lambda n, depth: _to_word(n // 1000000000, depth) + BIG_RANGE[2] + _to_word(n % 1000000000, True),
     1000000000000000: lambda n, depth: _to_word(n // 1000000000000, depth)
     + BIG_RANGE[3]
     + _to_word(n % 1000000000000, True),
@@ -101,7 +107,7 @@ def en_to_fa(string: str) -> str:
     :param string:  A string, will be converted
     :rtype: str
     """
-    return utils.replace(string, EN_TO_FA_MAP)
+    return EN_TO_FA_REGEX.sub(lambda x: EN_TO_FA_MAP[x.group()], string)
 
 
 def ar_to_fa(string: str) -> str:
@@ -114,7 +120,7 @@ def ar_to_fa(string: str) -> str:
     :param string: A string, will be converted
     :rtype: str
     """
-    return utils.replace(string, AR_TO_FA_MAP)
+    return AR_TO_FA_REGEX.sub(lambda x: AR_TO_FA_MAP[x.group()], string)
 
 
 def fa_to_en(string: str) -> str:
@@ -127,7 +133,7 @@ def fa_to_en(string: str) -> str:
     :param string: A string, will be converted
     :rtype: str
     """
-    return utils.replace(string, FA_TO_EN_MAP)
+    return FA_TO_EN_REGEX.sub(lambda x: FA_TO_EN_MAP[x.group()], string)
 
 
 def fa_to_ar(string: str) -> str:
@@ -140,7 +146,7 @@ def fa_to_ar(string: str) -> str:
     :param string: A string, will be converted
     :rtype: str
     """
-    return utils.replace(string, FA_TO_AR_MAP)
+    return FA_TO_AR_REGEX.sub(lambda x: FA_TO_AR_MAP[x.group()], string)
 
 
 def _to_word(number: int, depth: bool) -> str:

{persiantools-3.0.0 → persiantools-4.0.0}/persiantools/jdatetime.py

@@ -181,7 +181,7 @@ class JalaliDate:
         return year, month, day, locale
 
     @classmethod
-    def chack_date(cls, year, month, day):
+    def check_date(cls, year, month, day):
         try:
             cls._check_date_fields(year, month, day, "en")
         except (ValueError, TypeError):
@@ -191,11 +191,19 @@ class JalaliDate:
 
     @staticmethod
     def is_leap(year):
-        assert MINYEAR <= year <= MAXYEAR
+        """
+        This function calculates whether a given year in the Persian calendar is a leap year.
 
-        c = 0.24219858156028368  # 683 / 2820
-        # return ((year + 2346) * 683) % 2820 < 683
-        return ((year + 2346) * c) % 1 < c
+        It calculates `((year + 2346) * 683) % 2820`. This expression does a few things:
+        - It offsets the input year by 2346. This is done to align the Persian calendar with the astronomical solar year.
+        - It multiplies the result by 683, which is the number of leap years in a 2820-year cycle.
+        - It then takes the result modulo 2820 to get the position of the year within the current 2820-year cycle.
+
+        If the result of this calculation is less than 683, the year is a leap year in the Persian calendar.
+        This is because there are 683 leap years in each 2820-year cycle of the Persian calendar.
+        """
+        assert MINYEAR <= year <= MAXYEAR
+        return ((year + 2346) * 683) % 2820 < 683
 
     @classmethod
     def days_in_month(cls, month, year):
@@ -220,31 +228,40 @@ class JalaliDate:
             day = year.day
             year = year.year
 
-        g_d_m = [0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334]
+        # Days in each month of the Gregorian calendar
+        gregorian_days_in_month = [0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334]
 
-        jy = 0 if year <= 1600 else 979
+        # Determine the Jalali year
+        jalali_year = 0 if year <= 1600 else 979
         year -= 621 if year <= 1600 else 1600
-        year2 = year + 1 if month > 2 else year
-        days = (365 * year) + int((year2 + 3) / 4) - int((year2 + 99) / 100)
-        days += int((year2 + 399) / 400) - 80 + day + g_d_m[month - 1]
-        jy += 33 * int(days / 12053)
+
+        # Determine if the year is a leap year
+        leap_year = year + 1 if month > 2 else year
+
+        # Calculate the number of days
+        days = (365 * year) + (leap_year + 3) // 4 - (leap_year + 99) // 100
+        days += (leap_year + 399) // 400 - 80 + day + gregorian_days_in_month[month - 1]
+
+        # Update the Jalali year
+        jalali_year += 33 * (days // 12053)
         days %= 12053
-        jy += 4 * int(days / 1461)
+        jalali_year += 4 * (days // 1461)
         days %= 1461
-        jy += int((days - 1) / 365)
+        jalali_year += (days - 1) // 365
 
         if days > 365:
             days = (days - 1) % 365
 
+        # Determine the Jalali month and day
         if days < 186:
-            jm = 1 + int(days / 31)
-            jd = 1 + (days % 31)
+            jalali_month = 1 + days // 31
+            jalali_day = 1 + (days % 31)
         else:
-            arit = days - 186
-            jm = 7 + int(arit / 30)
-            jd = 1 + (arit % 30)
+            days -= 186
+            jalali_month = 7 + days // 30
+            jalali_day = 1 + (days % 30)
 
-        return cls(jy, jm, jd)
+        return cls(jalali_year, jalali_month, jalali_day)
 
     def to_gregorian(self):
         """based on jdf.scr.ir"""
@@ -252,37 +269,40 @@ class JalaliDate:
         day = self.day
         year = self.year
 
-        gy = 621 if year <= 979 else 1600
+        # Determine the Gregorian year
+        gregorian_year = 621 if year <= 979 else 1600
         year -= 0 if year <= 979 else 979
 
-        d = (month - 1) * 31 if month < 7 else ((month - 7) * 30) + 186
-        days = (365 * year) + (int(year / 33) * 8) + int(((year % 33) + 3) / 4)
-        days += 78 + day + d
+        # Calculate the number of days
+        days_in_month = (month - 1) * 31 if month < 7 else ((month - 7) * 30) + 186
+        days = (365 * year) + (year // 33) * 8 + ((year % 33) + 3) // 4
+        days += 78 + day + days_in_month
 
-        gy += 400 * int(days / 146097)
+        gregorian_year += 400 * (days // 146097)
         days %= 146097
 
         if days > 36524:
             days -= 1
-            gy += 100 * int(days / 36524)
+            gregorian_year += 100 * (days // 36524)
             days %= 36524
 
             if days >= 365:
                 days += 1
 
-        gy += 4 * int(days / 1461)
+        gregorian_year += 4 * (days // 1461)
         days %= 1461
-        gy += int((days - 1) / 365)
+        gregorian_year += (days - 1) // 365
 
         if days > 365:
             days = (days - 1) % 365
 
-        gd = days + 1
+        gregorian_day = days + 1
 
-        g_d_m = [
+        # Days in each month of the Gregorian calendar
+        gregorian_days_in_month = [
             0,
             31,
-            29 if (gy % 4 == 0 and gy % 100 != 0) or gy % 400 == 0 else 28,
+            29 if (gregorian_year % 4 == 0 and gregorian_year % 100 != 0) or gregorian_year % 400 == 0 else 28,
             31,
             30,
             31,
@@ -295,13 +315,13 @@ class JalaliDate:
             31,
         ]
 
-        _gm = 0
-        for _gm, g in enumerate(g_d_m):
-            if gd <= g:
+        # Determine the Gregorian month
+        for _gregorian_month, g in enumerate(gregorian_days_in_month):
+            if gregorian_day <= g:
                 break
-            gd -= g
+            gregorian_day -= g
 
-        return date(gy, _gm, gd)
+        return date(gregorian_year, _gregorian_month, gregorian_day)
 
     @classmethod
     def today(cls):
@@ -958,7 +978,7 @@ class JalaliDateTime(JalaliDate):
             "%B": cls.__seqToRE(cls, month_names, "B"),
             "%H": r"(?P<H>2[0-3]|[0-1]\d|\d)",
             "%I": r"(?P<I>1[0-2]|0[1-9]|[1-9])",
-            "%p": "(?i)" + cls.__seqToRE(cls, periods, "p"),
+            "%p": cls.__seqToRE(cls, periods, "p"),
             "%M": r"(?P<M>[0-5]\d|\d)",
             "%S": r"(?P<S>6[0-1]|[0-5]\d|\d)",
             "%f": r"(?P<f>\d{1,6})",
@@ -977,8 +997,8 @@ class JalaliDateTime(JalaliDate):
 
         data_string_regex = utils.replace(fmt, directives_regex_pattern)
 
-        if re.match(data_string_regex, data_string):
-            directives = re.search(data_string_regex, data_string).groupdict()
+        if re.match(data_string_regex, data_string, re.IGNORECASE):
+            directives = re.search(data_string_regex, data_string, re.IGNORECASE).groupdict()
 
             if "Y" in directives.keys() and len(directives.get("Y")) < 4:
                 raise ValueError("Year element must contain exactly 4 digits")
@@ -1100,7 +1120,7 @@ class JalaliDateTime(JalaliDate):
     def __base_compare(self, other):
         assert isinstance(other, JalaliDateTime)
 
-        y, m, d, h, m, s, ms = [
+        y, mo, d, h, m, s, ms = [
             self._year,
             self._month,
             self._day,
@@ -1109,7 +1129,7 @@ class JalaliDateTime(JalaliDate):
             self._second,
             self._microsecond,
         ]
-        y2, m2, d2, h2, m2, s2, ms2 = [
+        y2, mo2, d2, h2, m2, s2, ms2 = [
             other.year,
             other.month,
             other.day,
@@ -1121,10 +1141,8 @@ class JalaliDateTime(JalaliDate):
 
         return (
             0
-            if (y, m, d, h, m, s, ms) == (y2, m2, d2, h2, m2, s2, ms2)
-            else 1
-            if (y, m, d, h, m, s, ms) > (y2, m2, d2, h2, m2, s2, ms2)
-            else -1
+            if (y, mo, d, h, m, s, ms) == (y2, mo2, d2, h2, m2, s2, ms2)
+            else 1 if (y, mo, d, h, m, s, ms) > (y2, mo2, d2, h2, m2, s2, ms2) else -1
         )
 
     def _cmp(self, other, allow_mixed=False):

{persiantools-3.0.0 → persiantools-4.0.0/persiantools.egg-info}/PKG-INFO

@@ -1,24 +1,23 @@
 Metadata-Version: 2.1
 Name: persiantools
-Version: 3.0.0
+Version: 4.0.0
 Summary: Jalali date and datetime with other tools
 Home-page: https://github.com/majiidd/persiantools
 Author: Majid Hajiloo
 Author-email: majid.hajiloo@gmail.com
 License: MIT
 Keywords: jalali shamsi persian digits characters converter jalalidate jalalidatetime date datetime jdate jdatetime farsi
-Platform: UNKNOWN
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: Persian
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Software Development
@@ -26,9 +25,10 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Localization
 Classifier: Topic :: Utilities
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pytz
 
 # PersianTools
 
@@ -39,27 +39,25 @@ License-File: LICENSE
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/persiantools.svg)](https://pypi.org/project/persiantools/)
 [![PyPI - License](https://img.shields.io/pypi/l/persiantools.svg)](https://pypi.org/project/persiantools/)
 
-- Jalali (Shamsi) date and datetime (based on python datetime's module)
-
-  - Convert Jalali to Gregorian date/datetime and vice versa
-  - Support comparison and arithmetic operators such as `+`, `-`, `==`, `>=`
-  - Support timezone
-
-- Convert Arabic and Persian characters/digits to each other
-- Convert numbers to words
+Provides Jalali (also known as Shamsi or Persian) dates and datetimes functionalities, among other tools.
+- It converts between Jalali and Gregorian dates and datetimes (based on python datetime's module).
+- It supports operators like `+`, `-`, `==`, and `>=`.
+- It includes timezone support.
+- It converts between Arabic and Persian characters/digits.
+- It turns numbers into Persian words.
 
 ## Install Package
-
-```{.sourceCode .bash}
+You can install the package using pip with the following command:
+```bash
 python -m pip install persiantools
 ```
-Persiantools supports Python 3.6+. (_for python 2.7 and 3.5 use [1.5.x](https://github.com/majiidd/persiantools/tree/1.5.x) version_)
+Persiantools supports Python 3.8+. (_for python 2.7 and 3.5 use [1.5.x](https://github.com/majiidd/persiantools/tree/1.5.x) version_)
 
 ## How to use
 
 ### Date
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate
 >>> import datetime
 
@@ -84,7 +82,7 @@ JalaliDate(1367, 2, 14, Chaharshanbeh)
 
 ### Datetime
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDateTime
 >>> import datetime, pytz
 
@@ -108,7 +106,7 @@ JalaliDateTime(1395, 4, 17, 21, 23, 53, 474618, tzinfo=<UTC>)
 
 Based on python `strftime()` behavior
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate, JalaliDateTime
 >>> import pytz
 
@@ -127,7 +125,7 @@ Based on python `strftime()` behavior
 
 ### Digits/Characters Tools
 
-```{.sourceCode .python}
+```python
 >>> from persiantools import characters, digits
 
 >>> digits.en_to_fa("0987654321")
@@ -150,15 +148,15 @@ Based on python `strftime()` behavior
 ```
 
 ### Operators
-
-```{.sourceCode .python}
+The package supports various operators for date and time manipulations. Here are some examples:
+```python
 >>> from persiantools.jdatetime import JalaliDate, JalaliDateTime
 >>> import datetime
 
 >>> JalaliDate(1367, 2, 14) == JalaliDate(datetime.date(1988, 5, 4))
 True
 
->>> JalaliDateTime(1367, 2, 14, 4, 30) >= JalaliDateTime(1369, 7, 1, 1, 0)
+>>> JalaliDateTime(1367, 2, 14, 4, 30) >= JalaliDateTime(1368, 2, 14, 1, 0)
 False
 
 >>> JalaliDate(1367, 2, 14) == datetime.date(1988, 5, 4)
@@ -173,7 +171,7 @@ datetime.timedelta(365)
 
 ### Serializing and de-serializing
 
-```{.sourceCode .python}
+```python
 >>> from persiantools.jdatetime import JalaliDate
 >>> import pickle
 
@@ -189,5 +187,3 @@ datetime.timedelta(365)
 >>> jalali
 JalaliDate(1367, 2, 14, Chaharshanbeh)
 ```
-
-