https://github.com/miserlou/django-easy-timezones

Easy timezones for Django based on GeoIP
https://github.com/miserlou/django-easy-timezones

automatic django easy easy-timezones easy-to-use geoip python timezone

Last synced: 16 days ago
JSON representation

Easy timezones for Django based on GeoIP

• Host: GitHub
• URL: https://github.com/miserlou/django-easy-timezones
• Owner: Miserlou
• License: apache-2.0
• Created: 2013-07-17T05:27:45.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-07-20T22:44:06.000Z (over 1 year ago)
• Last Synced: 2024-09-23T01:54:57.952Z (about 2 months ago)
• Topics: automatic, django, easy, easy-timezones, easy-to-use, geoip, python, timezone
• Language: Python
• Homepage: http://gun.io/blog/django-easy-timezones/
• Size: 22.4 MB
• Stars: 202
• Watchers: 6
• Forks: 44
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Timezones. Yuck.](http://i.imgur.com/Qc2W47H.gif)

django-easy-timezones [![Build Status](https://travis-ci.org/Miserlou/django-easy-timezones.svg)](https://travis-ci.org/Miserlou/django-easy-timezones)

=====================

Easy IP-based timezones for Django (>=1.7) based on MaxMind GeoIP, with IPv6 support.

Quick start

-----------

1. Install django-easy-timezones

    ```python

    pip install django-easy-timezones

    ```

1. Add "easy-timezones" to your INSTALLED_APPS setting like this:

    ```python

    INSTALLED_APPS = (

      ...

      'easy_timezones',

    )

    ```

1. Add EasyTimezoneMiddleware to your MIDDLEWARE_CLASSES 

    ```python

    MIDDLEWARE_CLASSES = (

      ...

      'easy_timezones.middleware.EasyTimezoneMiddleware',

    )

    ```

1. (Optionally) Add a path to the [MaxMind GeoIP cities databases](http://dev.maxmind.com/geoip/legacy/geolite/) ([direct

link](http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz) because I'm nice) in your settings file:

    ```python

    GEOIP_DATABASE = '/path/to/your/geoip/database/GeoLiteCity.dat'

    GEOIPV6_DATABASE = '/path/to/your/geoip/database/GeoLiteCityv6.dat'

    ```

1. Enable localtime in your templates.

    ```python

    {% load tz %}

        The UTC time is {{ object.date }}

    {% localtime on %}

        The local time is {{ object.date }}

    {% endlocaltime %}

    ```

1. Twist one up, cause you're done, homie!

## Signals

You can also use signals to perform actions based on the timezone detection.

1. To hook into the Timezone detection event to, say, save it to the request's user somewhere more permanent than a session, do something like this:

	```python

	from easy_timezones.signals import detected_timezone	

	@receiver(detected_timezone, sender=MyUserModel)

	def process_timezone(sender, instance, timezone, **kwargs):

    	if instance.timezone != timezone:

        	instance.timezone = timezone

        	instance.save()

	```