nepali 1.0.0__tar.gz → 1.1.0__tar.gz

{nepali-1.0.0 → nepali-1.1.0}/PKG-INFO

@@ -1,10 +1,13 @@
 Metadata-Version: 2.1
 Name: nepali
-Version: 1.0.0
+Version: 1.1.0
 Summary: nepalidatetime compatible with python's datetime feature. Converting nepali date to english, parsing nepali datetime, nepali timezone, and timedelta support in nepali datetime
 Home-page: https://github.com/opensource-nepal/py-nepali
 Author: opensource-nepal
 Author-email: aj3sshh@gmail.com, sugatbajracharya49@gmail.com
+License: MIT
+Project-URL: Source, https://github.com/opensource-nepal/py-nepali
+Project-URL: Changelog, https://github.com/opensource-nepal/py-nepali/blob/main/CHANGELOG.md
 Keywords: nepali date conversion,convert date,nepali date time,python convert date,parse nepali date time
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
@@ -15,9 +18,9 @@ License-File: LICENSE
 # nepali
 
 [![PyPI version](https://badge.fury.io/py/nepali.svg)](https://badge.fury.io/py/nepali)
-[![CI status](https://github.com/opensource-nepal/py-nepali/actions/workflows/python-package.yml/badge.svg?branch=master)](https://github.com/opensource-nepal/py-nepali/actions)
+[![CI status](https://github.com/opensource-nepal/py-nepali/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/opensource-nepal/py-nepali/actions)
 [![Downloads](https://img.shields.io/pypi/dm/nepali.svg?maxAge=180)](https://pypi.org/project/nepali/)
-[![codecov](https://codecov.io/gh/opensource-nepal/py-nepali/branch/master/graph/badge.svg?token=PTUHYWCJ4I)](https://codecov.io/gh/opensource-nepal/py-nepali)
+[![codecov](https://codecov.io/gh/opensource-nepal/py-nepali/branch/main/graph/badge.svg?token=PTUHYWCJ4I)](https://codecov.io/gh/opensource-nepal/py-nepali)
 
 `nepali` is a python package containing features that will be useful for Nepali projects.
 
@@ -63,10 +66,11 @@ phone_number.parse("+977-9845217789")
    - [timezone](#timezone)
    - [parse](#parse)
    - [strftime() and strptime() Format Codes](#strftime-and-strptime-format-codes)
-2. [Numbers](#numbers)
-    - [nepalinumber](#nepalinumber)
-3. [Phone Number](#phone-number)
-4. [Locations](#locations)
+1. [Numbers](#numbers)
+   - [nepalinumber](#nepalinumber)
+1. [Phone Number](#phone-number)
+1. [Locations](#locations)
+1. [For Django Template](#for-django-template)
 
 ## Date and Time
 
@@ -310,7 +314,7 @@ np_datetime = parse("Jestha 15, 2079")                # 2079-02-15 00:00:00
 | `%A`      | Weekday as locale’s full name.                            | Sunday, Monday, …, Saturday    |
 | `%d`      | Day of the month as a zero-padded decimal number.         | 01, 02, …, 31                  |
 | `%-d`     | Day of the month as a decimal number.                     | 1, 2, …, 31                    |
-| `%B`      | Month as locale’s full name.                              | Baishak, Jestha, …, Chaitra    |
+| `%B`      | Month as locale’s full name.                              | Baishakh, Jestha, …, Chaitra   |
 | `%m`      | Month as a zero-padded decimal number.                    | 01, 02, …, 12                  |
 | `%-m`     | Month as a decimal number.                                | 1, 2, …, 12                    |
 | `%y`      | Year without century as a zero-padded decimal number.     | 00, 01, …, 99                  |
@@ -446,44 +450,9 @@ get_municipality(name_nepali="विराटनगर")
 
 ---
 
-## For Django Template
+## For Django
 
-Add `'nepali'` to your `INSTALLED_APPS` setting.
-
-```python
-INSTALLED_APPS = [
-    ...
-    'nepali',
-    ...
-]
-```
-
-In your Template
-
-```python
-{% load nepalidatetime %}
-```
-
-```python
-{% nepalinow %}
-```
-
-```python
-{% nepalinow '%Y-%m-%d' %}
-```
-
-```python
-{{ datetimeobj|nepalidate:"%Y-%m-%d" }}
-{{ datetimeobj|nepalidate_en:"%Y-%m-%d" }}
-```
-
-```python
-{{ datetimeobj|nepalihumanize }}
-```
-
-```python
-{{ forloop.counter|nepalinumber }}
-```
+We have created a new Django package called [django-nepali](https://github.com/opensource-nepal/django-nepali) to support `nepali` package. For more information, please visit [django-nepali](https://github.com/opensource-nepal/django-nepali).
 
 ## Contribution
 

{nepali-1.0.0 → nepali-1.1.0}/README.md

@@ -1,9 +1,9 @@
 # nepali
 
 [![PyPI version](https://badge.fury.io/py/nepali.svg)](https://badge.fury.io/py/nepali)
-[![CI status](https://github.com/opensource-nepal/py-nepali/actions/workflows/python-package.yml/badge.svg?branch=master)](https://github.com/opensource-nepal/py-nepali/actions)
+[![CI status](https://github.com/opensource-nepal/py-nepali/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/opensource-nepal/py-nepali/actions)
 [![Downloads](https://img.shields.io/pypi/dm/nepali.svg?maxAge=180)](https://pypi.org/project/nepali/)
-[![codecov](https://codecov.io/gh/opensource-nepal/py-nepali/branch/master/graph/badge.svg?token=PTUHYWCJ4I)](https://codecov.io/gh/opensource-nepal/py-nepali)
+[![codecov](https://codecov.io/gh/opensource-nepal/py-nepali/branch/main/graph/badge.svg?token=PTUHYWCJ4I)](https://codecov.io/gh/opensource-nepal/py-nepali)
 
 `nepali` is a python package containing features that will be useful for Nepali projects.
 
@@ -49,10 +49,11 @@ phone_number.parse("+977-9845217789")
    - [timezone](#timezone)
    - [parse](#parse)
    - [strftime() and strptime() Format Codes](#strftime-and-strptime-format-codes)
-2. [Numbers](#numbers)
-    - [nepalinumber](#nepalinumber)
-3. [Phone Number](#phone-number)
-4. [Locations](#locations)
+1. [Numbers](#numbers)
+   - [nepalinumber](#nepalinumber)
+1. [Phone Number](#phone-number)
+1. [Locations](#locations)
+1. [For Django Template](#for-django-template)
 
 ## Date and Time
 
@@ -296,7 +297,7 @@ np_datetime = parse("Jestha 15, 2079")                # 2079-02-15 00:00:00
 | `%A`      | Weekday as locale’s full name.                            | Sunday, Monday, …, Saturday    |
 | `%d`      | Day of the month as a zero-padded decimal number.         | 01, 02, …, 31                  |
 | `%-d`     | Day of the month as a decimal number.                     | 1, 2, …, 31                    |
-| `%B`      | Month as locale’s full name.                              | Baishak, Jestha, …, Chaitra    |
+| `%B`      | Month as locale’s full name.                              | Baishakh, Jestha, …, Chaitra   |
 | `%m`      | Month as a zero-padded decimal number.                    | 01, 02, …, 12                  |
 | `%-m`     | Month as a decimal number.                                | 1, 2, …, 12                    |
 | `%y`      | Year without century as a zero-padded decimal number.     | 00, 01, …, 99                  |
@@ -432,44 +433,9 @@ get_municipality(name_nepali="विराटनगर")
 
 ---
 
-## For Django Template
+## For Django
 
-Add `'nepali'` to your `INSTALLED_APPS` setting.
-
-```python
-INSTALLED_APPS = [
-    ...
-    'nepali',
-    ...
-]
-```
-
-In your Template
-
-```python
-{% load nepalidatetime %}
-```
-
-```python
-{% nepalinow %}
-```
-
-```python
-{% nepalinow '%Y-%m-%d' %}
-```
-
-```python
-{{ datetimeobj|nepalidate:"%Y-%m-%d" }}
-{{ datetimeobj|nepalidate_en:"%Y-%m-%d" }}
-```
-
-```python
-{{ datetimeobj|nepalihumanize }}
-```
-
-```python
-{{ forloop.counter|nepalinumber }}
-```
+We have created a new Django package called [django-nepali](https://github.com/opensource-nepal/django-nepali) to support `nepali` package. For more information, please visit [django-nepali](https://github.com/opensource-nepal/django-nepali).
 
 ## Contribution
 

{nepali-1.0.0/nepali/datetime → nepali-1.1.0/nepali}/constants.py

@@ -1,4 +1,12 @@
-MONTHS_EN = (
+"""
+This files contains constants for the py-Nepali project.
+"""
+
+# Nepali timezone
+NEPAL_TIMEZONE = "Asia/Kathmandu"
+
+# Nepali months in english
+NEPALI_MONTHS_EN = (
     "Baishakh",
     "Jestha",
     "Ashad",
@@ -13,7 +21,8 @@ MONTHS_EN = (
     "Chaitra",
 )
 
-MONTHS_NE = (
+# Nepali months in Nepali (devanagari)
+NEPALI_MONTHS_NE = (
     "बैशाख",
     "जेठ",
     "असार",
@@ -28,6 +37,7 @@ MONTHS_NE = (
     "चैत",
 )
 
+# Week names in english
 WEEKS_EN = (
     "Sunday",
     "Monday",
@@ -38,8 +48,10 @@ WEEKS_EN = (
     "Saturday",
 )
 
+# Week abbreviation name in english
 WEEKS_ABBR_EN = ("Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat")
 
+# Weeks names in Nepali (devanagari)
 WEEKS_NE = (
     "आइतबार",
     "सोमबार",
@@ -50,4 +62,5 @@ WEEKS_NE = (
     "शनिबार",
 )
 
+# Week abbreviation name in Nepali (devanagari)
 WEEKS_ABBR_NE = ("आइत", "सोम", "मंगल", "बुध", "बिही", "शुक्र", "शनि")

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/__init__.py

@@ -1,4 +1,4 @@
-from ._datetime import nepalidate, nepalitime, nepalidatetime
+from ._datetime import nepalidate, nepalidatetime, nepalitime
 from ._formatter import NepaliDateTimeFormatter
 from ._humanize import HumanizeDateTime, nepalihumanize
 from ._nepalimonth import nepalimonth

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/_datetime.py

@@ -1,7 +1,7 @@
 import datetime as pythonDateTime
 
 from nepali.date_converter import converter as nepali_date_converter
-from nepali.timezone import NepaliTimeZone, utc_now, to_nepali_timezone
+from nepali.timezone import NepaliTimeZone, to_nepali_timezone, utc_now
 
 from ._nepalimonth import nepalimonth
 
@@ -17,31 +17,31 @@ class formatter_class_mixin:
 
     @classmethod
     def init_formatter_class(cls):
-        if not hasattr(cls, "__formatter_class__Cache"):
+        if not hasattr(cls, "_formatter_class_cache"):
             from ._formatter import NepaliDateTimeFormatter
 
-            cls.__formatter_class__Cache = NepaliDateTimeFormatter
-        return cls.__formatter_class__Cache
+            cls._formatter_class_cache = NepaliDateTimeFormatter
+        return cls._formatter_class_cache
 
     @classmethod
     def get_strptime_method(cls):
-        if not hasattr(cls, "_strptime_method_CACHE"):
+        if not hasattr(cls, "_strptime_method_cache"):
             from .parser import strptime
 
-            cls._strptime_method_CACHE = strptime
-        return cls._strptime_method_CACHE
+            cls._strptime_method_cache = strptime
+        return cls._strptime_method_cache
 
     def strftime(self, format: str) -> str:
         return self.strftime_en(format)
 
     def strftime_en(self, format: str) -> str:
-        NepaliDateTimeFormatter = self.get_formatter_class()
-        formatter = NepaliDateTimeFormatter(self, devanagari=False)
+        nepali_datetime_formatter = self.get_formatter_class()
+        formatter = nepali_datetime_formatter(self, devanagari=False)
         return formatter.get_str(format)
 
     def strftime_ne(self, format: str) -> str:
-        NepaliDateTimeFormatter = self.get_formatter_class()
-        formatter = NepaliDateTimeFormatter(self, devanagari=True)
+        nepali_datetime_formatter = self.get_formatter_class()
+        formatter = nepali_datetime_formatter(self, devanagari=True)
         return formatter.get_str(format)
 
 
@@ -194,12 +194,11 @@ class nepalidate(formatter_class_mixin):
 
     @staticmethod
     def from_date(date_object):
-        npDate = nepalidate(
+        return nepalidate(
             *nepali_date_converter.english_to_nepali(
                 date_object.year, date_object.month, date_object.day
             )
         )
-        return npDate
 
     @staticmethod
     def from_nepalidatetime(datetime_object):

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/_formatter.py

@@ -1,4 +1,5 @@
 import datetime as pythonDateTime
+
 from nepali import number
 from nepali.exceptions import (
     InvalidDateFormatException,
@@ -40,7 +41,7 @@ class NepaliDateTimeFormatter:
     }
 
     def __init__(self, datetime_object, devanagari=False):
-        # TODO: Change variable npDateTime into snakecase: `np_date_time`
+        # TODO: Change variable npDateTime into snake case: `np_date_time`
         if type(datetime_object) == nepalidatetime:
             self.npDateTime = datetime_object
         elif type(datetime_object) == nepalidate:
@@ -100,7 +101,7 @@ class NepaliDateTimeFormatter:
 
     def get_format_map(self, ch: str) -> str:
         if ch not in self.format_map:
-            raise InvalidDateFormatException("Invalid Date format %{}".format(ch))
+            raise InvalidDateFormatException(f"Invalid Date format %{ch}")
         return self.format_map[ch]
 
     @property

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/_humanize.py

@@ -1,10 +1,7 @@
-import datetime as pythonDateTime
-
 from nepali import number
-from nepali.timezone import now, to_nepali_timezone
-from nepali.exceptions import InvalidNepaliDateTimeObjectException
+from nepali.timezone import now
 
-from ._datetime import nepalidate, nepalidatetime
+from .utils import to_nepalidatetime
 
 
 class HumanizeDateTime:
@@ -29,20 +26,7 @@ class HumanizeDateTime:
         threshold (kwargs): threshold to be humanize
         format (kwargs): format to display behind threshold
         """
-        if type(datetime_obj) == nepalidatetime:
-            self.datetime_obj = datetime_obj.to_datetime()
-        elif type(datetime_obj) == nepalidate:
-            self.datetime_obj = nepalidatetime.from_nepali_date(
-                datetime_obj
-            ).to_datetime()
-        elif type(datetime_obj) == pythonDateTime.date:
-            self.datetime_obj = nepalidatetime.from_date(datetime_obj).to_datetime()
-        elif type(datetime_obj) == pythonDateTime.datetime:
-            self.datetime_obj = to_nepali_timezone(datetime_obj)
-        else:
-            raise InvalidNepaliDateTimeObjectException(
-                "Argument must be instance of NepaliDate or NepaliDateTime or datetime.datetime or datetime.date"
-            )
+        self.datetime_obj = to_nepalidatetime(datetime_obj)
 
         self.threshold = kwargs.get("threshold")
         self.format = kwargs.get("format")
@@ -53,8 +37,11 @@ class HumanizeDateTime:
     def __calc_seconds(self):
         """calculates total seconds from now"""
         current_date_time = now()
-        date = self.datetime_obj
-        self.seconds = int((current_date_time - date).total_seconds())
+
+        # TODO (@aj3sh): support datetime - nepalidatetime
+        self.seconds = int(
+            (current_date_time - self.datetime_obj.to_datetime()).total_seconds()
+        )
 
         self.interval_tense = self.__past_text
         if self.seconds < 0:
@@ -67,13 +54,12 @@ class HumanizeDateTime:
         """returns humanize string"""
         seconds = self.__calc_seconds()  # calculating seconds
 
-        if self.threshold is not None:
-            if seconds >= self.threshold:
-                return self.get_datetime().strip()
+        if self.threshold is not None and seconds >= self.threshold:
+            return self._get_datetime_str().strip()
 
-        return self.get_humanize().strip()
+        return self._get_humanize_str().strip()
 
-    def get_humanize(self):
+    def _get_humanize_str(self):
         """
         returns humanize datetime
         """
@@ -118,14 +104,13 @@ class HumanizeDateTime:
             str(interval_value) + " " + str(interval_text) + " " + self.interval_tense
         )
 
-    def get_datetime(self):
+    def _get_datetime_str(self):
         """
         returns date in nepali characters
         """
         if not self.format:
             self.format = "%B %d, %Y"
-        ndt = nepalidatetime.from_datetime(self.datetime_obj)
-        return ndt.strftime_ne(self.format)
+        return self.datetime_obj.strftime_ne(self.format)
 
     def __str__(self):
         return self.to_str()

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/_nepalimonth.py

@@ -1,7 +1,7 @@
 from functools import cached_property
 from typing import Any, Dict, Optional, Union
 
-from .constants import MONTHS_EN, MONTHS_NE
+from nepali.constants import NEPALI_MONTHS_EN, NEPALI_MONTHS_NE
 
 
 class NepaliMonthMeta(type):
@@ -40,7 +40,8 @@ class NepaliMonthMeta(type):
 
         return cls._cache[value]
 
-    def _parse_str(cls, month: str) -> int:
+    @staticmethod
+    def _parse_str(month: str) -> int:
         """
         Parses str value of the month and returns int.
 
@@ -54,7 +55,7 @@ class NepaliMonthMeta(type):
             return int(month)
 
         month = month.capitalize()
-        month_names = MONTHS_EN + MONTHS_NE
+        month_names = NEPALI_MONTHS_EN + NEPALI_MONTHS_NE
         try:
             index = month_names.index(month)
         except ValueError:
@@ -66,7 +67,7 @@ class NepaliMonthMeta(type):
 class nepalimonth(metaclass=NepaliMonthMeta):
     """
     Represents Nepali month: Baishakh, Jestha, ..., Chaitra.
-    Baishak: 1,
+    Baishakh: 1,
     Jestha: 2,
     ...
     Chaitra: 12
@@ -107,9 +108,9 @@ class nepalimonth(metaclass=NepaliMonthMeta):
     @cached_property
     def name(self) -> str:
         """Month's english name"""
-        return MONTHS_EN[self.__value - 1]
+        return NEPALI_MONTHS_EN[self.__value - 1]
 
     @cached_property
     def name_ne(self) -> str:
         """Month's nepali name"""
-        return MONTHS_NE[self.__value - 1]
+        return NEPALI_MONTHS_NE[self.__value - 1]

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/_nepaliweek.py

@@ -1,7 +1,7 @@
 from functools import cached_property
 from typing import Any, Dict, Optional, Union
 
-from .constants import WEEKS_EN, WEEKS_NE, WEEKS_ABBR_EN, WEEKS_ABBR_NE
+from nepali.constants import WEEKS_ABBR_EN, WEEKS_ABBR_NE, WEEKS_EN, WEEKS_NE
 
 
 class NepaliWeekMeta(type):
@@ -28,7 +28,7 @@ class NepaliWeekMeta(type):
                 pass
 
         # checking if week is valid
-        if value is None or not (0 <= value <= 6):
+        if value is None or not 0 <= value <= 6:
             raise ValueError(f"Invalid week: {week}")
 
         # checking cache
@@ -37,7 +37,8 @@ class NepaliWeekMeta(type):
 
         return cls._cache[value]
 
-    def _parse_str(cls, week: str) -> int:
+    @staticmethod
+    def _parse_str(week: str) -> int:
         """
         Parses str value of the week and returns int.
 

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/parser/__init__.py

@@ -1,4 +1,4 @@
-from ._parser import strptime, parse
+from ._parser import parse, strptime
 
 __all__ = [
     "strptime",

{nepali-1.0.0 → nepali-1.1.0}/nepali/datetime/parser/_parser.py

@@ -1,4 +1,4 @@
-from nepali.exceptions import InvalidDateTimeFormatException, FormatNotMatchException
+from nepali.exceptions import FormatNotMatchException, InvalidDateTimeFormatException
 
 from .validators import validate
 
@@ -53,10 +53,8 @@ def _get_standard_formats():
     for time_format in STANDARD_TIME_FORMAT:
         for date_format in STANDARD_DATE_FORMAT:
             _standard_datetime_format_CACHE += [
-                "{} {}".format(date_format, time_format)
-            ]
-            _standard_datetime_format_CACHE += [
-                "{}, {}".format(date_format, time_format)
+                f"{date_format} {time_format}",
+                f"{date_format}, {time_format}",
             ]
     return _standard_datetime_format_CACHE
 
@@ -67,10 +65,10 @@ def parse(datetime_str):
     eg. parse('2078-10-12') => <NepaliDateTime: 2078-10-12>
     """
     standard_formats = _get_standard_formats()
-    nepalidatetime_object = None
     for format in standard_formats:
-        nepalidatetime_object = validate(datetime_str, format=format)
-        if nepalidatetime_object is not None:
-            return nepalidatetime_object
+        try:
+            return strptime(datetime_str, format=format)
+        except FormatNotMatchException:
+            pass
 
     raise InvalidDateTimeFormatException("Invalid format to parse nepali datetime.")