Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slashmili/django-jalali
Jalali DateField support for Django model
https://github.com/slashmili/django-jalali
Last synced: 26 days ago
JSON representation
Jalali DateField support for Django model
- Host: GitHub
- URL: https://github.com/slashmili/django-jalali
- Owner: slashmili
- License: bsd-3-clause
- Created: 2011-08-02T06:53:43.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T23:15:52.000Z (about 2 months ago)
- Last Synced: 2024-11-16T14:36:13.212Z (27 days ago)
- Language: Python
- Homepage: http://pypi.python.org/pypi/django_jalali
- Size: 1.04 MB
- Stars: 257
- Watchers: 14
- Forks: 52
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-persian - django-jalali - Jalali DateField support for Django model. (Jalali Date)
README
Django Jalali
=============
This module gives you a DateField same as Django’s DateField but you can
get and query data based on Jalali Date
Status
------
.. image:: https://github.com/slashmili/django-jalali/workflows/Tests/badge.svg?branch=main
:target: https://github.com/slashmili/django-jalali/actions
.. image:: https://img.shields.io/pypi/v/django_jalali.svg
:target: https://pypi.python.org/pypi/django_jalali
.. image:: https://img.shields.io/pypi/pyversions/django-jalali.svg
:target: https://pypi.org/project/django_jalali
.. image:: https://img.shields.io/pypi/djversions/django-jalali.svg
:target: https://pypi.org/project/django-jalali/
Dependencies
------------
- jdatetime_
- Django_ > 4.2
Looking for Django 1.X support? Checkout *2.4.6* version in pypi.org
- `Django REST Framework`_ > 3.12 (If install with ``drf`` dependency)
Supported Databases
-------------------
- SQLite
- PostgreSQL
Install
-------
.. code:: bash
pip install django_jalali
To use DRF serializer field:
.. code:: bash
pip install django_jalali[drf]
Usage
-----
1. Run :
.. code:: bash
$ django-admin startproject jalali_test
2. Start your app :
.. code:: bash
$ python manage.py startapp foo
3. Edit settings.py_ and add django_jalali and your foo to your INSTALLED_APPS (also config DATABASES setting)
django_jalali should be added **before** your apps in order to work properly
4. Edit foo/models.py_
.. code:: python
from django.db import models
from django_jalali.db import models as jmodels
class Bar(models.Model):
objects = jmodels.jManager()
name = models.CharField(max_length=200)
date = jmodels.jDateField()
def __str__(self):
return "%s, %s" % (self.name, self.date)
class BarTime(models.Model):
objects = jmodels.jManager()
name = models.CharField(max_length=200)
datetime = jmodels.jDateTimeField()
def __str__(self):
return "%s, %s" % (self.name, self.datetime)
5. Run
.. code:: bash
$ python manage.py makemigrations
Migrations for 'foo':
foo/migrations/0001_initial.py:
- Create model Bar
- Create model BarTime
$ python manage.py migrate
Running migrations:
Applying foo.0001_initial... OK
6. Test it
.. code:: shell
$ python manage.py shell
Python 3.8.18 (default, Nov 26 2018, 15:26:54)
[GCC 6.3.0 20170516] on linux
Type "help", "copyright", "credits" or "license" for more information.
(InteractiveConsole)
>>> from foo.models import Bar
>>> import jdatetime
>>> today = jdatetime.date(1390, 5, 12)
>>> mybar = Bar(name="foo", date=today)
>>> mybar.save()
>>> mybar.date
jdatetime.date(1390, 5, 12)
>>> Bar.objects.filter(date=today)
[]
>>> Bar.objects.filter(date__gte="1390-5-12")
[]
>>> Bar.objects.filter(date='1363-8-01')
[]
>>> from foo.models import BarTime
>>> BarTime(name="Bar Time now", datetime=jdatetime.datetime(1380,8,2,12,12,12)).save()
>>> BarTime.objects.filter(datetime__date=jdatetime.datetime(1380,8,2,12,12,12))
[]
>>> BarTime.objects.filter(datetime__date=jdatetime.date(1380,8,2))
[]
>>> BarTime.objects.filter(datetime__date="1380-08-02")
[]
>>> BarTime.objects.filter(datetime__lt=jdatetime.datetime(1380,8,2,12,12,12))
[]
>>> BarTime.objects.filter(datetime__lte=jdatetime.datetime(1380,8,2,12,12,12))
[]
>>> BarTime.objects.filter(datetime__gt='1380-08-02')
[]
>>> BarTime.objects.filter(datetime__gt=d)
[]
>>> BarTime.objects.filter(datetime__year=1380)
[]
⚠️ `__month` filter is not supported as explained in here_
Using Templatetags
------------------
1. You can use ``jformat`` filter to format your dates in templates:
.. code:: python
{% load jformat %}
{{ my_date|jformat }} {# default formatting #}
{{ my_date|jformat:"%A %d %B %Y %H:%M" }} {# specific formatting #}
Admin Interface
---------------
1. Create foo/admin.py_
.. code:: python
from foo.models import Bar, BarTime
from django.contrib import admin
from django_jalali.admin.filters import JDateFieldListFilter
# You need to import this for adding jalali calendar widget
import django_jalali.admin as jadmin
class BarAdmin(admin.ModelAdmin):
list_filter = (
('date', JDateFieldListFilter),
)
admin.site.register(Bar, BarAdmin)
class BarTimeAdmin(admin.ModelAdmin):
list_filter = (
('datetime', JDateFieldListFilter),
)
admin.site.register(BarTime, BarTimeAdmin)
2. Config admin interface and fire up your django and enjoy using jalali date !
Django rest framework
---------------------
There are serializer fields corresponding to ``jmodels.JDateField`` and ``jmodels.JDateTimeField`` for DRF:
.. code:: python
from django_jalali.serializers.serializerfield import JDateField, JDateTimeField
from rest_framework.serializers import ModelSerializer
from foo.models import Bar, BarTime
class JDateFieldSerialializer(ModelSerializer):
date = JDateField()
class Meta:
model = Bar
exclude = []
class JDateTimeFieldSerializer(ModelSerializer):
datetime = JDateTimeField()
class Meta:
model = BarTime
exclude = []
Locale
------
In order to get the date string in farsi you need to set the locale to fa_IR
There are two ways to do achieve that, you can use of the approaches based on your needs
* Run server with LC_ALL env:
.. code:: shell
$ LC_ALL=fa_IR python manage.py runserver
* Set the locale in settings.py
.. code:: python
LANGUAGE_CODE = 'fa-ir'
import locale
locale.setlocale(locale.LC_ALL, "fa_IR.UTF-8")
* If using Docker, add the following to your Dockerfile:
.. code:: dockerfile
FROM python:3.11-slim-bookworm
RUN apt-get update && apt-get -y install locales && \
sed -i -e 's/# fa_IR UTF-8/fa_IR UTF-8/' /etc/locale.gen && \
dpkg-reconfigure --frontend=noninteractive locales
Timezone Settings
-----------------
From *django_jalali* version 3 and *Django* 2 you can use ``TIME_ZONE`` and ``USE_TZ`` settings_ to save datetime with project timezone
Development
-----------
You can contribute to this project forking it from GitHub and sending pull requests.
First fork_ the repository_ and then clone it:
.. code:: shell
$ git clone [email protected]:/django-jalali.git
Initialize a virtual environment for development purposes:
.. code:: shell
$ python -m venv django_jalali_env
$ source ~/django_jalali_env/bin/activate
Then install the necessary requirements:
.. code:: shell
$ cd django-jalali
$ pip install -r requirements-test.txt
Unit tests are located in the ``tests`` folder and can be easily run with the pytest tool:
.. code:: shell
$ pytest
Before committing, you can run all the above tests against all supported Python and Django versions with tox.
You need to install tox first:
.. code:: shell
$ pip install tox
And then you can run all tests:
.. code:: shell
$ tox
If you wish to limit the testing to specific environment(s), you can parametrize the tox run:
.. code:: shell
$ tox -e py39-django42
.. _jdatetime: https://github.com/slashmili/python-jalali
.. _Django: https://www.djangoproject.com/
.. _settings.py: https://github.com/slashmili/django-jalali/blob/master/jalali_test/jalali_test/settings.py#L40
.. _models.py: https://github.com/slashmili/django-jalali/blob/master/jalali_test/foo/models.py
.. _admin.py: https://github.com/slashmili/django-jalali/blob/master/jalali_test/foo/admin.py
.. _settings: https://github.com/slashmili/django-jalali/blob/master/jalali_test/jalali_test/settings.py#L116
.. _Django REST Framework: https://www.django-rest-framework.org/
.. _fork: https://help.github.com/en/articles/fork-a-repo
.. _repository: https://github.com/slashmili/django-jalali
.. _here: https://github.com/slashmili/django-jalali/issues/142#issuecomment-887464050