README.rst

Python Bikram Samwat

Utilities to work with Bikram/Vikram Samwat dates. Documentation: https://bikram.readthedocs.io.

Getting started

• Install the bikram package: https://bikram.readthedocs.io/installation.html.
• Read the usage guide: https://bikram.readthedocs.io/usage.html.
• Read the module reference guide: https://bikram.readthedocs.io/bikram.html.

Features

• Convert Bikram Samwat dates to AD and vice versa. Intended to be useful for Nepali software developers.
• Well tested and readable source code.
• Date operations, i.e. addition/subtraction, supported with datetime.date and datetime.timedelta within range.
• Supports comparison with datetime.date and datetime.timedelta objects.

Caveats

• Is not very helpful if the date falls outside the map of BS years to days in month.

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.