opensource-nepal / django-nepali Goto Github PK

10.0 3.0 3.0 33 KB

A django package on top of 'nepali' python package which supports nepali date time, time conversion, etc on django projects.

License: GNU General Public License v3.0

Python 98.97% Makefile 1.03%

ad-to-bs bs-to-ad django jinja jinja2 nepal nepali nepali-date nepali-date-converter nepalidate

django-nepali's Introduction

django-nepali

A django package on top of nepali python package which supports nepali date time, time conversion, etc on django projects.

Requirements

django
nepali >= 1.0.0

Installation

pip install django-nepali

On settings.py, add 'django_nepali' to your INSTALLED_APPS.

INSTALLED_APPS = [
    ...
    'django_nepali',
    ...
]

Django Templates

nepalidatetime

In your Template

{% load nepalidatetime %}

nepalinow

nepalinow renders the current Nepali date and time in 'en-US' locale (English).

For default date format

{% nepalinow %}

For custom date format

{% nepalinow '%Y-%m-%d' %}

nepalinow_ne

nepalinow_ne renders the current Nepali date and time in 'ne' locale (Nepali).

For default date format

{% nepalinow_ne %}

For custom date format

{% nepalinow_ne '%Y-%m-%d' %}

nepalidate

nepalidate renders the datetime object into nepali datetime format in 'en-US' locale (English).

For default date format

{{ datetime_obj|nepalidate }}

For custom date format

{{ datetime_obj|nepalidate:"%Y-%m-%d" }}

nepalidate_ne

nepalidate_ne renders the datetime object into nepali datetime format in 'ne' locale (Nepali).

For default date format

{{ datetime_obj|nepalidate_ne }}

For custom date format

{{ datetime_obj|nepalidate_ne:"%Y-%m-%d" }}

nepalihumanize

nepalihumanize renders the datetime object to a human readable form for 'ne' locale (Nepali)

{{ datetime_obj|nepalihumanize }}

Humanize threshold

You can provide a threshold input, measured in seconds, to the nepalihumanize filter. If the time difference between the current time and the datetime_obj is greater than the specified threshold, then instead of relative time as provided by the humanize function, the datetime_obj will be displayed in the specified format (if provided), or else in the default format.

{{ datetime_obj|nepalihumanize:1000 }}

nepalinumber

In your Template

{% load nepalinumber %}

nepalinumber renders the english number into nepali format (devanagari)

{{ forloop.counter|nepalinumber }}

{{ 150|nepalinumber }}

nepali_comma

Renders the given value with commas added in Nepali style without converting the number.

{{ number|nepali_comma }}

This would convert a number such as 100000 into 1,00,000.

english_comma

Renders the given value with commas added in English style without converting the number.

{{ number|english_comma }}

This would convert a number such as 100000 into 100,000.

nepalinumber with comma

Converts the number into nepali number and renders it. Basically same as {{ number|nepalinumber|nepali_comma }}

{{ number|nepalinumber_with_comma }}

This would convert a number such as 1000 into १,०००.

Contribution

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

django-nepali's People

Stargazers

Watchers

Forkers

sugat009 aj3sh kneeraazon404

django-nepali's Issues

Implement django tests and Setup Github Actions

Setup and configure Django tests on this project. The tests might extend to model testing, form testing, template testing, etc.
This task also includes running tests on GitHub Actions

Implement NepaliDateField for Django Models and Forms

As an extended package of 'nepali', we need to create a new field called NepaliDateField in Django that supports Nepali dates. This field will be used in both Django models and forms.

Model Usage

Initialization

class MyNepaliInfo(models.Model):
    ...
    birthday = NepaliDateField(...)
    ...

Saving data

This field will support both Python's date and nepalidate.

info = MyNepaliInfo()
info.birthday = nepalidate(2051, 4, 29)  # nepali date
...
info.save()

# OR
info.birthday = datetime.date(1994, 8, 13)  # Python's date

# OR

MyNepaliInfo.objects.create(
    ...
    birthday = nepalidate(2051, 4, 29),
    ...
)

Filtering

Filtering should be done by both Python's date and nepalidate. Also, user should be able to filter with nepali date's year, month, or day.

# filtering with nepalidate
MyNepaliInfo.objects.filter(birthday=nepalidate(2051, 2, 29))

# filtering with Python's date
MyNepaliInfo.objects.filter(birthday=date(1994, 8, 13)

# date range filtering
MyNepaliInfo.objects.filter(birthday__range=(nepalidate1, nepalidate2))
MyNepaliInfo.objects.filter(birthday__gt=nepalidate1)

# Filtering with Nepali year, same goes for the month and day
MyNepaliInfo.objects.filter(birthday__year=2051)

# Filtering with English year
MyNepaliInfo.objects.filter(birthday__year_en=1994)

Form Usage

Initialization

class MyNepaliInfoForm(forms.Form):
    ...
    birthday = NepaliDateFormField(...)
    ...

...

Github Actions implementation for release

Implement Github actions for triggering the release process (eg. building code, compiling docs, publishing package, etc). This Github action should be dependent on the Github release.

Implement NepaliPhoneNumberField for Django Models and Forms

Create a model/form field for the nepali phone number.

Example usage:

class MyInfo(models.Model):
    ...
    phone_number = NepaliPhoneNumberField(...)
    ...

Update Community standards

Following Community Standards include:

Github Project description
Readme document
Code of Conduct
Contributing document
License
Security policy
Issues templates
PR template

Implement NepaliDateTimeField for Django Models and Forms

As an extended package of 'nepali', we need to create a new field called NepaliDateTimeField in Django that supports Nepali dates and times. This field will be used in both Django models and forms.

The implementation will be the same as the implementation of "NepaliDate". Please refer to issue #5

opensource-nepal / django-nepali Goto Github PK

django-nepali's Introduction

django-nepali

Requirements

Installation

Django Templates

nepalidatetime

nepalinow

For default date format

For custom date format

nepalinow_ne

For default date format

For custom date format

nepalidate

For default date format

For custom date format

nepalidate_ne

For default date format

For custom date format

nepalihumanize

Humanize threshold

nepalinumber

nepali_comma

english_comma

nepalinumber with comma

Contribution

django-nepali's People

Stargazers

Watchers

Forkers

django-nepali's Issues

Model Usage

Initialization

Saving data

Filtering

Form Usage

Initialization

Recommend Projects

Recommend Topics

Recommend Org