https://github.com/aerawatcorp/bikram

Pythonic date object, parser, converter to work with Bikram Samwat (Nepali) dates
https://github.com/aerawatcorp/bikram

bikram-samwat date-converter nepali-date nepali-date-converter python

Last synced: 14 days ago
JSON representation

Pythonic date object, parser, converter to work with Bikram Samwat (Nepali) dates

• Host: GitHub
• URL: https://github.com/aerawatcorp/bikram
• Owner: aerawatcorp
• License: mit
• Created: 2016-11-13T11:04:39.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-20T08:24:39.000Z (7 months ago)
• Last Synced: 2024-12-08T11:36:33.456Z (26 days ago)
• Topics: bikram-samwat, date-converter, nepali-date, nepali-date-converter, python
• Language: Python
• Homepage: https://bikram.readthedocs.io
• Size: 5.41 MB
• Stars: 14
• Watchers: 4
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
bikram

------

.. image:: https://img.shields.io/pypi/v/bikram.svg

        :target: https://pypi.python.org/pypi/bikram

.. image:: https://img.shields.io/travis/poudel/bikram.svg

        :target: https://travis-ci.org/poudel/bikram

.. image:: https://readthedocs.org/projects/bikram/badge/?version=latest

        :target: https://bikram.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status

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

Getting started

---------------

* Install the :code:`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 in a few line of codes.

  Intended to be useful for Nepali software developers.

* Well tested and readable source code.

* Date operations, i.e. addition/subtraction,

  supported with :code:`datetime.date` and :code:`datetime.timedelta` within range.

* Supports comparison with :code:`datetime.date` and :code:`datetime.timedelta` objects.

* Supports string formatting of `samwat` dates.

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.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage