nepdate-python

Bikram Sambat (Nepali calendar) dates, conversion, formatting and parsing for Python 3.11 and newer. Part of the NepDate family: the shared data and spec live in the hub sanamhub/nepdate; the C# original is NepDate.

Status: 0.1.0-beta.1 (0.1.0b1 on PyPI), the first public pre-release. The API is listed in docs/API.md and may still change before 0.1.0. Patro data (tithi, holidays, events) is informational, not an official calendar.

• Import nepdate. The core distribution is nepdate-core, because nepdate on PyPI belongs to an unrelated project (ADR-0007).
• Tithi, public holidays and events are a separate distribution, nepdate-patro (import nepdate_patro). The core has none of that data.
• Pure Python, zero runtime dependencies (except tzdata on Windows, for today()), typed (py.typed), and works on free-threaded 3.14t.
• BS 1901-01-01 to 2199-12-30 (AD 1844-04-11 to 2143-04-15). Same results as C# NepDate and the other ports, proved by the shared vectors.

Install

pip install --pre nepdate-core

--pre is needed while only pre-releases exist; pin nepdate-core==0.1.0b1 to stay on this one.

Quick start

>>> from nepdate import Lang, NepaliDate
>>> d = NepaliDate(2080, 5, 15)
>>> str(d)
'2080/05/15'
>>> d.to_date()
datetime.date(2023, 9, 1)
>>> d.long(weekday=True, lang=Lang.NE)
'शुक्रवार, भदौ १५, २०८०'
>>> NepaliDate.parse("2080/05/15") == d
True

Arithmetic stays on the BS calendar, so month lengths come from the shared data rather than from the Gregorian calendar:

>>> d.add_days(1000)
NepaliDate(2083, 2, 14)
>>> d.add_months(13)
NepaliDate(2081, 6, 15)
>>> d.fiscal_year().label()
'2080/81'

Patro: tithi, holidays and events

The core has no patro data. Install both distributions:

pip install --pre nepdate-core nepdate-patro

>>> from nepdate import Lang, NepaliDate
>>> from nepdate_patro import coverage, info
>>> day = info(NepaliDate(2080, 5, 15))
>>> day.is_public_holiday
True
>>> day.tithi.label(Lang.EN)
'Dwitiya'
>>> [event.label(Lang.EN) for event in day.events]
['Saparu (Gaijatra) (Kathmandu Holiday)', 'Ropain Jatra']
>>> coverage().start
NepaliDate(2077, 1, 1)

info never raises: a date outside the coverage returns one shared empty CalendarInfo. The data currently covers BS 2077-01-01 to 2084-08-20.

API

The complete signatures, defaults and exceptions are in the API contract.

Documentation

License

MIT (LICENSE). Calendar data from NepDate by Raju Prasai and contributors, MIT (NOTICE). Not affiliated with the Government of Nepal.