django-timezone-field-ng
A Django app providing database and form fields for pytz timezone objects.
Examples
Database Field
import pytz
from django.db import models
from timezone_field import TimeZoneField
class MyModel(models.Model):
timezone1 = TimeZoneField(default='Europe/London') # defaults supported
timezone2 = TimeZoneField()
timezone3 = TimeZoneField()
my_inst = MyModel(
timezone1='America/Los_Angeles', # assignment of a string
timezone2=pytz.timezone('Turkey'), # assignment of a pytz.DstTzInfo
timezone3=pytz.UTC, # assignment of pytz.UTC singleton
)
my_inst.full_clean() # validates against pytz.common_timezones
my_inst.save() # values stored in DB as strings
tz = my_inst.timezone1 # values retrieved as pytz objects
repr(tz) # "<DstTzInfo 'America/Los_Angeles' PST-1 day, 16:00:00 STD>"
Form Field
from django import forms
from timezone_field import TimeZoneFormField
class MyForm(forms.Form):
timezone = TimeZoneFormField()
my_form = MyForm({
'timezone': 'America/Los_Angeles',
})
my_form.full_clean() # validates against pytz.common_timezones
tz = my_form.cleaned_data['timezone'] # values retrieved as pytz objects
repr(tz) # "<DstTzInfo 'America/Los_Angeles' PST-1 day, 16:00:00 STD>"
Installation
-
pip install django-timezone-field-ng
-
Add timezone_field to your settings.INSTALLED_APPS:
INSTALLED_APPS = ( ... 'timezone_field', ... )
Changelog
- 2.0 (2016-09-09)
- Fork the repository from mfogel and tag 2.0 release
- 2.0rc1 (2016-01-31)
- Drop support for django 1.7, add support for django 1.9
- Drop support for python 3.2, 3.3, add support for python 3.5
- Remove tests from source distribution
- 1.3 (2015-10-12)
- Drop support for django 1.6, add support for django 1.8
- Various bug fixes
- 1.2 (2015-02-05)
- For form field, changed default list of accepted timezones from pytz.all_timezones to pytz.common_timezones, to match DB field behavior.
- 1.1 (2014-10-05)
- Django 1.7 compatibility
- Added support for formating choices kwarg as [[<str>, <str>], ...], in addition to previous format of [[<pytz.timezone>, <str>], ...].
- Changed default list of accepted timezones from pytz.all_timezones to pytz.common_timezones. If you have timezones in your DB that are in pytz.all_timezones but not in pytz.common_timezones, this is a backward-incompatible change. Old behavior can be restored by specifying choices=[(tz, tz) for tz in pytz.all_timezones] in your model definition.
- 1.0 (2013-08-04)
- Initial release as timezone_field.
Running the Tests
-
Install tox.
-
From the repository root, run
tox
Postgres will need to be running locally, and sqlite will need to be installed in order for tox to do its job.
Found a Bug?
To file a bug or submit a patch, please head over to django-timezone-field-ng on github.
Credits
This project is a fork of the work done by Mike Fogel's django-timezones
And was originally adapted from Brian Rosner's django-timezones. The full list of contributors is available on github.