nepali 1.1.0

nepalidatetime compatible with python's datetime feature. Converting nepali date to english, parsing nepali datetime, nepali timezone, and timedelta support in nepali datetime

nepali

nepali is a python package containing features that will be useful for Nepali projects.

The major feature of this package is nepalidatetime, which is compatible with python's datetime feature. It helps nepali date to english, parsing nepali datetime, nepali timezone, and timedelta support in nepali datetime.

Example

import datetime
from nepali import phone_number
from nepali.datetime import nepalidate, parser

nepali_datetime = parser.parse('2079-02-15')
# 2079-02-15 00:00:00

date = datetime.date(2017, 3, 15)
nepali_date = nepalidate.from_date(date)
# 2073-12-02

phone_number.parse("[phone]")
# {
#     'type':      'Mobile',
#     'number':    '9845217789',
#     'operator':  <Operator: Nepal Telecom>
# }

Requirements

Python >= 3

Installation

pip install nepali

Features

1. Date and Time
   • date_converter
   • nepalidate
   • nepalidatetime
   • nepalihumanize
   • timezone
   • parse
   • strftime() and strptime() Format Codes
2. Numbers
   • nepalinumber
3. Phone Number
4. Locations
5. For Django Template

Date and Time

date_converter

Date converter module converts english date to nepali and nepali date to english. It doesn't contain any extra functionality.

Convert English date to Nepali date

from nepali.date_converter import converter

np_year, np_month, np_date = converter.english_to_nepali(en_year, en_month, en_date)

Example

from nepali.date_converter import converter

np_year, np_month, np_date = converter.english_to_nepali(2023, 2, 7)
print(np_year, np_month, np_date) # 2079 10 24

Convert Nepali date to English date

from nepali.date_converter import converter

en_year, en_month, en_date = converter.nepali_to_english(np_year, np_month, np_date)

Example

from nepali.date_converter import converter

en_year, en_month, en_date = converter.nepali_to_english(2079, 10, 24)
print(en_year, en_month, en_date) # 2023 2 7

nepalidate

Creating a new nepalidate object

from nepali.datetime import nepalidate

# nepalidate object with year, month, day
np_date = nepalidate(year, month, day)

# nepalidate object with today's date
np_date = nepalidate.today()

# parse nepali date
np_date = nepalidate.strptime('2078-01-18', format='%Y-%m-%d')

Getting nepalidate object from python datetime

# from date object
np_date = nepalidate.from_date(date_obj)

# from datetime object
np_date = nepalidate.from_datetime(datetime_obj)

Attributes and Methods

np_date.year                       # 2078 (year)
np_date.month                      # 1 (month)
np_date.day                        # 18 (day)

np_date.to_date()                  # datetime.date object
np_date.to_datetime()              # datetime.datetime object
np_date.to_nepalidatetime()        # nepalidatetime object

np_date.strftime("%Y-%m-%d")       # 2078-01-18
np_date.strftime_ne("%Y-%m-%d")    # २०७८-०१-१८

np_date.weekday()                  # Sunday => 0, Monday => 1, ..., Saturday => 6

nepalidatetime

Creating a new nepalidatetime object

from nepali.datetime import nepalidatetime

# nepalidate object with year, month, day, hour, minute, second
np_datetime = nepalidatetime(year, month, day[, hour[, minute[, second]]])

# nepalidate object with current date and time
np_datetime = nepalidate.now()
np_datetime = nepalidate.today()

# parse nepali datetime
np_datetime = nepalidatetime.strptime('2078-01-12 13:12', format='%Y-%m-%d %H:%M')

Getting nepalidatetime object from python datetime

# from date object
np_datetime = nepalidatetime.from_date(date_obj)

# from datetime object
np_datetime = nepalidatetime.from_datetime(datetime_obj)

Getting nepalidatetime object from nepalidate

np_datetime = nepalidatetime.from_nepalidate(nepali_date)

Attributes and Methods

np_date.year                             # 2078 (year)
np_date.month                            # 1 (month)
np_date.day                              # 18 (day)
np_date.hour                             # 23 (hour)
np_date.minute                           # 59 (minute)
np_date.second                           # 59 (day)

np_date.to_date()                        # datetime.date object
np_date.to_datetime()                    # datetime.datetime object
np_date.to_nepalidate()                  # nepalidatetime object
np_date.to_time()                        # nepalitime object (datetime.time compatible)

np_date.strftime("%Y-%m-%d %H:%M")       # 2078-01-18 23:59
np_date.strftime_ne("%Y-%m-%d %H:%M")    # २०७८-०१-१८ २३:५९

np_date.weekday()                        # Sunday => 0, Monday => 1, ..., Saturday => 6

Timedelta support

# timedelta addition and subtraction
np_datetime - datetime.timedelta(days=3)       # returns nepalidatetime

# comparison between two dates
np_datetime1 - np_datetime2                    # returns timedelta object
np_datetime1 < np_datetime2                    # returns bool (True/False)
np_datetime1 >= datetime.datetime.now()        # returns bool (True/False)
...

nepalihumanize

Returns readable form of nepali date.

from nepali.datetime import nepalihumanize


nepalihumanize(datetime, [threshold, format])

The threshold is and optional field and is in seconds and the format is for the strftime format. If the datetime object crosses the threshold it print the date with the format. The format is also an optional and is %B %d, %Y in default.

Example

from nepali.datetime import nepalihumanize, nepalidatetime

np_datetime = nepalidatetime(2079, 10, 5)
output = nepalihumanize(np_datetime)
# output: ३ महिना अघि

output = nepalihumanize(np_datetime, threshold=1400)
# 1400 = 2 * 30 * 24; two months threshold
# output: माघ ०५, २०७९

timezone

NepaliTimeZone You can use NepaliTimeZone directly to your datetime object.

from nepali.timezone import NepaliTimeZone

datetime.datetime(2018, 8, 12, 16, 23, tzinfo=NepaliTimeZone())

now Returns current datetime object with timezone

from nepali import timezone

timezone.now()

datetime.now() vs timezone.now(): datetime.now() doesn't contain timezone, but timezone.now() will contain timezone of the system.

utc_now Returns current UTC datetime object (with timezone UTC)

from nepali import timezone

timezone.utc_now()

parse

Parses date with commonly used date formats. Auto detects date format. If you are sure about the format, please use strptime.

from nepali.datetime.parser import parse

np_datetime = parse(datetime_str)

Example

np_datetime = parse("2079-02-15")                     # 2079-02-15 00:00:00
np_datetime = parse("२०७८-०१-१८")                      # 2078-01-15 00:00:00
np_datetime = parse("2079/02/15")                     # 2079-02-15 00:00:00
np_datetime = parse("2079-02-15 15:23")               # 2079-02-15 15:23:00
np_datetime = parse("2079-02-15 5:23 AM")             # 2079-02-15 05:23:00
np_datetime = parse("2079-02-15 5:23 AM")             # 2079-02-15 05:23:00
np_datetime = parse("Jestha 15, 2079")                # 2079-02-15 00:00:00

strftime() and strptime() Format Codes

Directive	Meaning	Example
%A	Weekday as locale’s abbreviated name.	Sun, Mon, …, Sat (आइत, सोम, …)
%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.	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
%Y	Year with century as a decimal number.	2001, 2078, 2079, …, 2099
%H	Hour (24-hour clock) as a zero-padded decimal number.	00, 01, …, 23
%-H	Hour (24-hour clock) as a decimal number.	0, 1, 2, …, 23
%I	Hour (12-hour clock) as a zero-padded decimal number.	01, 02, …, 12
%-I	Hour (12-hour clock) as a decimal number.	1, 2, …, 12
%p	Locale’s equivalent of either AM or PM.	AM, PM (en_US)
%M	Minute as a zero-padded decimal number.	00, 01, …, 59
%-M	Minute as a decimal number.	0, 1, 2, …, 59
%S	Second as a zero-padded decimal number.	00, 01, …, 59
%-S	Second as a decimal number.	0, 1, 2, …, 59
%f	Microsecond as a decimal number, zero-padded to 6 digits.	000000, 000001, …, 999999
%%	A literal '%' character.	%

---

Numbers

from nepali import number

convert Converts english number to nepali.

np_number = number.convert("1234567890")  # १२३४५६७८९०

revert Converts english number to nepali.

en_number = number.revert("१२३४५६७८९०")  # 1234567890

add_comma Adds comma in nepali numbers.

number_text = number.add_comma("1234567890")  # 1,23,45,67,890

nepalinumber

nepalinumber is a new data type, which can be used to represent Nepali (Devanagari) numbers. It allows us to perform arithmetic operations, just like with int and float. Additionally, it can be used to parse numbers and output them in Devanagari format.

from nepali.number import nepalinumber

Parsing

a = nepalinumber("१८.२७")
print(a)  # 18.27

b = nepalinumber(15)
print(b)  # 15

Nepali (Devanagari) output

a = nepalinumber("18.27")
print(a.str_ne())  # १८.२७

Arithmetic operations

a = nepalinumber("1")
b = nepalinumber("२")
c = a + b * 3
print(c)  # 7

---

Phone Number

from nepali import phone_number

is_valid Checks is the given number is a valid nepali phone number.

phone_number.is_valid("9851377890")      # True
phone_number.is_valid("[phone]")  # True

phone_number.is_valid("8251377890")      # False

parse Parse phone number and returns details of the number.

phone_number.parse("9851377890")
# {'type': 'Mobile', 'number': '9851377890', 'operator': <Operator: Nepal Telecom>}

phone_number.parse("[phone]")
# {'type': 'Landline', 'number': '0142314819', 'area_code': '01'}

---

Locations

Provides details of Nepal's Province, District, and Municipality.

from nepali.locations import provinces, districts, municipalities

from nepali.locations.utils import get_province, get_district, get_municipality

# Province
get_province(name="Bagmati")
# Bagmati Province

# District
get_district(name="Kathmandu")
# Kathmandu

# Municipality
get_municipality(name="Kathmandu")
# Kathmandu Metropolitan City

# Municipality
get_municipality(name_nepali="विराटनगर")
# Biratnagar Metropolitan City

---

For Django

We have created a new Django package called django-nepali to support nepali package. For more information, please visit django-nepali.

Contribution

We appreciate feedback and contribution to this package. To get started please see our contribution guide