{"id":13814283,"url":"https://github.com/mfogel/django-timezone-field","last_synced_at":"2025-05-14T03:11:13.891Z","repository":{"id":2993951,"uuid":"4010596","full_name":"mfogel/django-timezone-field","owner":"mfogel","description":"A Django app providing DB, form, and REST framework fields for zoneinfo and pytz timezone objects.","archived":false,"fork":false,"pushed_at":"2025-05-06T04:36:41.000Z","size":560,"stargazers_count":408,"open_issues_count":5,"forks_count":95,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-05-08T00:02:08.174Z","etag":null,"topics":["django","python","timezones"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mfogel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"open_collective":"mfogel"}},"created_at":"2012-04-12T23:48:59.000Z","updated_at":"2025-05-06T04:36:44.000Z","dependencies_parsed_at":"2023-07-05T18:32:28.602Z","dependency_job_id":"2f95110a-fe15-4259-ae90-97288fcb25ea","html_url":"https://github.com/mfogel/django-timezone-field","commit_stats":{"total_commits":336,"total_committers":23,"mean_commits":"14.608695652173912","dds":"0.28869047619047616","last_synced_commit":"914e3ef979e00d819f74e3ae498a0f7b518556f1"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfogel%2Fdjango-timezone-field","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfogel%2Fdjango-timezone-field/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfogel%2Fdjango-timezone-field/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfogel%2Fdjango-timezone-field/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mfogel","download_url":"https://codeload.github.com/mfogel/django-timezone-field/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166521,"owners_count":21864482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","python","timezones"],"created_at":"2024-08-04T04:01:51.149Z","updated_at":"2025-05-14T03:11:13.840Z","avatar_url":"https://github.com/mfogel.png","language":"Python","funding_links":["https://opencollective.com/mfogel"],"categories":["Python"],"sub_categories":[],"readme":"# django-timezone-field\n\n[![CI](https://github.com/mfogel/django-timezone-field/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mfogel/django-timezone-field/actions)\n[![codecov](https://codecov.io/gh/mfogel/django-timezone-field/branch/main/graph/badge.svg?token=Rwekzmim3l)](https://codecov.io/gh/mfogel/django-timezone-field)\n[![pypi downloads](https://img.shields.io/pypi/dm/django-timezone-field.svg)](https://pypi.python.org/pypi/django-timezone-field/)\n[![pypi python support](https://img.shields.io/pypi/pyversions/django-timezone-field.svg)](https://pypi.python.org/pypi/django-timezone-field/)\n[![pypi django support](https://img.shields.io/pypi/djversions/django-timezone-field.svg)](https://pypi.python.org/pypi/django-timezone-field/)\n\nA Django app providing DB, form, and REST framework fields for\n[`zoneinfo`](https://docs.python.org/3/library/zoneinfo.html) and [`pytz`](http://pypi.python.org/pypi/pytz/) timezone\nobjects.\n\n## The transition from `pytz` to `zoneinfo`\n\nLike Django, this app supports both `pytz` and `zoneinfo` objects while the community transitions away from `pytz` to\n`zoneinfo`. All exposed fields and functions that return a timezone object accept an optional boolean kwarg `use_pytz`.\n\nIf not explicitly specified, the default value used for `use_pytz` matches Django's behavior:\n\n- Django \u003c= 3.X: `use_pytz` defaults to `True`\n- Django == 4.X: `use_pytz` defaults to the value of\n  [`django.conf.settings.USE_DEPRECATED_PYTZ`](https://docs.djangoproject.com/en/4.0/ref/settings/#use-deprecated-pytz),\n  which itself defaults to `False`\n- Django \u003e= 5.X: \n  [drops support for `pytz` altogether](https://docs.djangoproject.com/en/5.0/releases/5.0/#features-removed-in-5-0),\n  and this app has done the same.\n\nNote that this app does _not_ declare `pytz` to be a dependency, so if you're using this app with `use_pytz=True`, you'll need\nto ensure `pytz` is included in the environment yourself.\n\n### Differences in recognized timezones between `pytz` and `zoneinfo`\n\n`pytz` and `zoneinfo` search for timezone data differently.\n\n- `pytz` bundles and searches within its own copy of the [IANA timezone DB](https://www.iana.org/time-zones)\n- `zoneinfo` first searches the local system's timezone DB for a match. If no match is found, it then searches within\n  the [`tzdata`](https://pypi.org/project/tzdata/) package _if it is installed_. The `tzdata` package contains a copy of\n  the IANA timezone DB.\n\nIf the local system's timezone DB doesn't cover the entire IANA timezone DB and the `tzdata` package is not installed,\nyou may run across errors like `ZoneInfoNotFoundError: 'No time zone found with key Pacific/Kanton'` for seemingly valid\ntimezones when transitioning from `pytz` to `zoneinfo`. The easy fix is to add `tzdata` to your project with\n`poetry add tzdata` or `pip install tzdata`.\n\nAssuming you have the `tzdata` package installed if needed, no\n[data migration](https://docs.djangoproject.com/en/4.0/topics/migrations/#data-migrations) should be necessary when\nswitching from `pytz` to `zoneinfo`.\n\n## Examples\n\n### Database Field\n\n```python\nimport zoneinfo\nimport pytz\nfrom django.db import models\nfrom timezone_field import TimeZoneField\n\nclass MyModel(models.Model):\n    tz1 = TimeZoneField(default=\"Asia/Dubai\")               # defaults supported, in ModelForm renders like \"Asia/Dubai\"\n    tz2 = TimeZoneField(choices_display=\"WITH_GMT_OFFSET\")  # in ModelForm renders like \"GMT+04:00 Asia/Dubai\"\n    tz3 = TimeZoneField(use_pytz=True)                      # returns pytz timezone objects\n    tz4 = TimeZoneField(use_pytz=False)                     # returns zoneinfo objects\n\nmy_model = MyModel(\n    tz2=\"America/Vancouver\",                     # assignment of a string\n    tz3=pytz.timezone(\"America/Vancouver\"),      # assignment of a pytz timezone\n    tz4=zoneinfo.ZoneInfo(\"America/Vancouver\"),  # assignment of a zoneinfo\n)\nmy_model.full_clean() # validates against pytz.common_timezones by default\nmy_model.save()       # values stored in DB as strings\nmy_model.tz3          # value returned as pytz timezone: \u003cDstTzInfo 'America/Vancouver' LMT-1 day, 15:48:00 STD\u003e\nmy_model.tz4          # value returned as zoneinfo: zoneinfo.ZoneInfo(key='America/Vancouver')\n\nmy_model.tz1 = \"UTC\"  # assignment of a string, immediately converted to timezone object\nmy_model.tz1          # zoneinfo.ZoneInfo(key='UTC') or pytz.utc, depending on use_pytz default\nmy_model.tz2 = \"Invalid/Not_A_Zone\"  # immediately raises ValidationError\n```\n\n### Form Field\n\n```python\nfrom django import forms\nfrom timezone_field import TimeZoneFormField\n\nclass MyForm(forms.Form):\n    tz1 = TimeZoneFormField()                                   # renders like \"Asia/Dubai\"\n    tz2 = TimeZoneFormField(choices_display=\"WITH_GMT_OFFSET\")  # renders like \"GMT+04:00 Asia/Dubai\"\n    tz3 = TimeZoneFormField(use_pytz=True)                      # returns pytz timezone objects\n    tz4 = TimeZoneFormField(use_pytz=False)                     # returns zoneinfo objects\n\nmy_form = MyForm({\"tz3\": \"Europe/Berlin\", \"tz4\": \"Europe/Berlin\"})\nmy_form.full_clean()         # validates against pytz.common_timezones by default\nmy_form.cleaned_data[\"tz3\"]  # value returned as pytz timezone: \u003cDstTzInfo 'Europe/Berlin' LMT+0:53:00 STD\u003e\nmy_form.cleaned_data[\"tz4\"]  # value returned as zoneinfo: zoneinfo.ZoneInfo(key='Europe/Berlin')\n```\n\n### REST Framework Serializer Field\n\n```python\nfrom rest_framework import serializers\nfrom timezone_field.rest_framework import TimeZoneSerializerField\n\nclass MySerializer(serializers.Serializer):\n    tz1 = TimeZoneSerializerField(use_pytz=True)\n    tz2 = TimeZoneSerializerField(use_pytz=False)\n\nmy_serializer = MySerializer(data={\n    \"tz1\": \"America/Argentina/Buenos_Aires\",\n    \"tz2\": \"America/Argentina/Buenos_Aires\",\n})\nmy_serializer.is_valid()\nmy_serializer.validated_data[\"tz1\"]  # \u003cDstTzInfo 'America/Argentina/Buenos_Aires' LMT-1 day, 20:06:00 STD\u003e\nmy_serializer.validated_data[\"tz2\"]  # zoneinfo.ZoneInfo(key='America/Argentina/Buenos_Aires')\n```\n\n## Installation\n\nReleases are hosted on [`pypi`](https://pypi.org/project/django-timezone-field/) and can be installed using various\npython packaging tools.\n\n```bash\n# with poetry\npoetry add django-timezone-field\n\n# with pip\npip install django-timezone-field\n```\n\n## Running the tests\n\nFrom the repository root, with [`poetry`](https://python-poetry.org/):\n\n```bash\npoetry install\npoetry run pytest\n```\n\n## Changelog\n\n#### 7.1 (2025-01-11)\n\n- Add support for python 3.13\n\n#### 7.0 (2024-07-07)\n\n- Better default sorting of `choices` ([#116](https://github.com/mfogel/django-timezone-field/issues/116)), ([#123](https://github.com/mfogel/django-timezone-field/issues/123))\n- Convert string value to timezone object immediately on creation/assignment.\n  Accessing a TimeZoneField will _always_ return a timezone or None (never a string).\n  (Potentially BREAKING: Unknown timezone names now raise `ValidationError` at time of assignment.\n  Previously, conversion was delayed until model `full_clean` or `save`.) \n  ([#57](https://github.com/mfogel/django-timezone-field/issues/57))\n- Add support for django 5.1\n- Drop support for django 3.2, 4.0, 4.1\n- Change base class of `TimeZoneSerializerField` from DJRF's `Field` to `CharField` ([#137](https://github.com/mfogel/django-timezone-field/issues/137))\n\n#### 6.1.0 (2023-11-25)\n\n- Add support for django 5.0\n- Add support for python 3.12\n- Fix issue with `Factory` timezone on some BSD systems ([#114](https://github.com/mfogel/django-timezone-field/issues/114))\n\n#### 6.0.1 (2023-09-07)\n\n- Use correct default backend when running with django 3.X ([#109](https://github.com/mfogel/django-timezone-field/issues/109))\n\n#### 6.0 (2023-08-20)\n\n- BREAKING: `pytz` removed from dependencies. If you use this package with `use_pytz=True`, you'll need to install\n  `pytz` yourself.\n- Drop support for django 2.2\n- Drop support for python 3.7\n\n#### 5.1 (2023-06-18)\n\n- Add django as a dependency of this package, with correct version constraints\n  ([#90](https://github.com/mfogel/django-timezone-field/issues/90))\n- Add support for django 4.1, 4.2\n- Add support for python 3.11\n\n#### 5.0 (2022-02-08)\n\n- Add support for `zoneinfo` objects ([#79](https://github.com/mfogel/django-timezone-field/issues/79))\n- Add support for django 4.0\n- Remove `timezone_field.utils.add_gmt_offset_to_choices`, `display_GMT_offset` kwarg (use `choices_display` instead)\n- Drop support for django 3.0, 3.1\n- Drop support for python 3.5, 3.6\n\n#### 4.2.3 (2022-01-13)\n\n- Fix sdist installs ([#78](https://github.com/mfogel/django-timezone-field/issues/78))\n- Officially support python 3.10\n\n#### 4.2.1 (2021-07-07)\n\n- Reinstate `TimeZoneField.default_choices` ([#76](https://github.com/mfogel/django-timezone-field/issues/76))\n\n#### 4.2 (2021-07-07)\n\n- Officially support django 3.2, python 3.9\n- Fix bug with field deconstruction ([#74](https://github.com/mfogel/django-timezone-field/issues/74))\n- Housekeeping: use poetry, github actions, pytest\n\n#### 4.1.2 (2021-03-17)\n\n- Avoid `NonExistentTimeError` during DST transition ([#70](https://github.com/mfogel/django-timezone-field/issues/70))\n\n#### 4.1.1 (2020-11-28)\n\n- Don't import `rest_framework` from package root ([#67](https://github.com/mfogel/django-timezone-field/issues/67))\n\n#### 4.1 (2020-11-28)\n\n- Add Django REST Framework serializer field\n- Add new `choices_display` kwarg with supported values `WITH_GMT_OFFSET` and `STANDARD`\n- Deprecate `display_GMT_offset` kwarg\n\n#### 4.0 (2019-12-03)\n\n- Add support for django 3.0, python 3.8\n- Drop support for django 1.11, 2.0, 2.1, python 2.7, 3.4\n\n#### 3.1 (2019-10-02)\n\n- Officially support django 2.2 (already worked)\n- Add option to display TZ offsets in form field ([#46](https://github.com/mfogel/django-timezone-field/issues/46))\n\n#### 3.0 (2018-09-15)\n\n- Support django 1.11, 2.0, 2.1\n- Add support for python 3.7\n- Change default human-readable timezone names to exclude underscores\n  ([#32](https://github.com/mfogel/django-timezone-field/issues/32) \u0026\n  [#37](https://github.com/mfogel/django-timezone-field/issues/37))\n\n#### 2.1 (2018-03-01)\n\n- Add support for django 1.10, 1.11\n- Add support for python 3.6\n- Add wheel support\n- Support bytes in DB fields ([#38](https://github.com/mfogel/django-timezone-field/issues/38) \u0026\n  [#39](https://github.com/mfogel/django-timezone-field/issues/39))\n\n#### 2.0 (2016-01-31)\n\n- Drop support for django 1.7, add support for django 1.9\n- Drop support for python 3.2, 3.3, add support for python 3.5\n- Remove tests from source distribution\n\n#### 1.3 (2015-10-12)\n\n- Drop support for django 1.6, add support for django 1.8\n- Various [bug fixes](https://github.com/mfogel/django-timezone-field/issues?q=milestone%3A1.3)\n\n#### 1.2 (2015-02-05)\n\n- For form field, changed default list of accepted timezones from `pytz.all_timezones` to `pytz.common_timezones`, to\n  match DB field behavior.\n\n#### 1.1 (2014-10-05)\n\n- Django 1.7 compatibility\n- Added support for formatting `choices` kwarg as `[[\u003cstr\u003e, \u003cstr\u003e], ...]`, in addition to previous format of\n  `[[\u003cpytz.timezone\u003e, \u003cstr\u003e], ...]`.\n- Changed default list of accepted timezones from `pytz.all_timezones` to `pytz.common_timezones`. If you have timezones\n  in your DB that are in `pytz.all_timezones` but not in `pytz.common_timezones`, this is a backward-incompatible\n  change. Old behavior can be restored by specifying `choices=[(tz, tz) for tz in pytz.all_timezones]` in your model\n  definition.\n\n#### 1.0 (2013-08-04)\n\n- Initial release as `timezone_field`.\n\n## Credits\n\nOriginally adapted from [Brian Rosner's django-timezones](https://github.com/brosner/django-timezones).\n\nMade possible thanks to the work of the\n[contributors](https://github.com/mfogel/django-timezone-field/graphs/contributors).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfogel%2Fdjango-timezone-field","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmfogel%2Fdjango-timezone-field","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfogel%2Fdjango-timezone-field/lists"}