wgordon17 / awesome-django-timezones

Easily set a localized timezone for users

Awesome Django Timezones

Easily set a localized timezone for users

Documentation

The full documentation is at https://awesome-django-timezones.readthedocs.io.

Quickstart

Install Awesome Django Timezones:

pip install awesome-django-timezones

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'awesome_django_timezones',
    ...
)

Add DjangoTimezonesMiddleware to your MIDDLEWARE_CLASSES:

MIDDLEWARE_CLASSES = (
    ...
    'awesome_django_timezones.middleware.TimezonesMiddleware',
    ...
)

Add js/awesome_django_timezones.js to your base template

<script src="{% static 'awesome_django_timezones/js/awesome_django_timezones.js' %}"></script>

(Optional) If you need Django to be timezone aware on the Admin page, you will have to extend the Admin base.html in your_project/templates/admin/base.html

{% extends 'admin/base.html' %}
{% load static %}

{% block footer %}
  {{ block.super }}

  <script src="{% static 'js/awesome_django_timezones.js' %}"></script>

{% endblock %}

Features

• Provides an accurate method of determining the an end user's timezone and activating that timezone in Django.
• Uses client side, JavaScript detection for the most accurate method of determining a timezone.
  • Uses the widely supported, native Intl JavaScript library to detect the client's timezone. This library is not currently implemented for IE11.
• Falls back to server side timezone detection via an IP API.
  • Fall back is provided for IE11 clients or clients with JavaScript disabled.
  • Relies on third-party IP API lookups by https://ipapi.co. Consider purchasing a plan if you need more than 30k IP lookups/month or if you need support (no affiliation).
• Set a fallback timezone to always use in case a timezone can't be found with AWESOME_TZ_DEFAULT_TZ in your settings.py. (Be sure to use the "TZ database name" column from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install -r requirements_test.txt
(myenv) $ tox

Credits

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-djangopackage
• ipapi

awesome-django-timezones's Issues

Is it possible to disable looking up IP addresses in a third party service?

Currently, if the Javascript fails, it falls back to looking up the IP address in a third party service. Is it possible to disable this fallback? There are privacy implications to sharing IP addresses, as they could be considered personally identifiable information.

Otherwise, this package looks really interesting, especially since it uses modern Javascript browser APIs.

We got the production down because of this, don't use it

Traceback (most recent call last):
  File "/root/.local/share/virtualenvs/app-4PlAip0Q/lib/python3.8/site-packages/django/core/handlers/exception.py", line 47, in inner
    response = get_response(request)
  File "/root/.local/share/virtualenvs/app-4PlAip0Q/lib/python3.8/site-packages/sentry_sdk/integrations/django/middleware.py", line 134, in __call__
    return f(*args, **kwargs)
  File "/root/.local/share/virtualenvs/app-4PlAip0Q/lib/python3.8/site-packages/sentry_sdk/integrations/django/middleware.py", line 90, in sentry_wrapped_method
    return old_method(*args, **kwargs)
  File "/root/.local/share/virtualenvs/app-4PlAip0Q/lib/python3.8/site-packages/awesome_django_timezones/middleware.py", line 32, in __call__
    ip_info = ipapi.location(ip=get_ip_address(request), key=getattr(settings, 'DJANGO_IPAPI_KEY', None))
  File "/root/.local/share/virtualenvs/app-4PlAip0Q/lib/python3.8/site-packages/ipapi/ipapi.py", line 87, in location
    raise RateLimited(data)
ipapi.exceptions.RateLimited: {'error': True, 'reason': 'RateLimited', 'message': 'Visit https://ipapi.co/ratelimited/ for details'}
127.0.0.1 - - [31/Aug/2020:06:00:25 -0400] "POST /.............../ HTTP/1.0" 500 145 "-" ""