Metadata-Version: 1.1
Name: django-whoshere
Version: 0.1.1
Summary: Django Admin plugin to see who is logged in and active. Supports GeoIp and user-agents.
Home-page: https://github.com/koed00/django-whoshere
Author: Ilan Steemers
Author-email: koed00@gmail.com
License: MIT
Description: Django WhosHere
        ===============
        
        A simple Django Admin plugin showing who's logged in and active on your
        site using the cache. Supports
        `GeoIP <https://docs.djangoproject.com/en/1.8/ref/contrib/gis/geoip/>`__
        and `user-agents <https://github.com/selwin/python-user-agents>`__ .
        
        Requirements
        ------------
        
        -  `Django <https://www.djangoproject.com>`__ >= 1.7
        
        Optional
        ^^^^^^^^
        
        -  `user-agents <https://github.com/selwin/python-user-agents>`__ Adds
           nicer user agent formatting
        
        -  `GeoIP <https://docs.djangoproject.com/en/1.8/ref/contrib/gis/geoip/>`__
           Looks up City and Country based on IP
        
        -  `django-geoip-utils <https://github.com/Gidsy/django-geoip-utils>`__
           The lazy way of setting up GeoIP for your project
        
        Installation
        ------------
        
        -  Make sure you have Django's
           `Cache <https://docs.djangoproject.com/en/1.8/topics/cache/>`__
           backend set up.
        -  Install using pip: ``pip install django-whoshere``
        -  Add ``django_whoshere`` to ``INSTALLED_APPS`` in settings.py:
        
           .. code:: python
        
               INSTALLED_APPS = (
                   # other apps
                   'django_whoshere',
               )
        
        -  Add ``django_whoshere.middelware.TrackMiddleware`` to your
           ``MIDDLEWARE_CLASSES``. Make sure it comes after your Authentication
           middleware.
        
        .. code:: python
        
            MIDDLEWARE_CLASSES = (
                # other middleware
                'django.contrib.auth.middleware.AuthenticationMiddleware',
                'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
                'django_whoshere.middleware.TrackMiddleware',
               # more middleware
            )
        
        Optional
        ^^^^^^^^
        
        -  Install
           `user-agents <https://github.com/selwin/python-user-agents>`__ for
           nicer user agent formatting
        -  Configure
           `GeoIP <https://docs.djangoproject.com/en/1.8/ref/contrib/gis/geoip/>`__
           or just install
           `django-geoip-utils <https://github.com/Gidsy/django-geoip-utils>`__
           for geo location of your users
        
        Configuration
        -------------
        
        No configuration is needed but these settings are provided for
        convenience:
        
        -  ``WHOSHERE_TIMEOUT=300`` Sets the timeout for user activity. Defaults
           to 300 seconds.
        -  ``WHOSHERE_LABEL='Active Users'`` Overrides the admin link label.
           Defaults to 'Active Users'
        -  ``WHOSHERE_PREFIX='whoshere'`` Prefix used in cache keys. Defaults to
           'whoshere'.
        
        Notes
        -----
        
        -  Middleware is kept as small as possible and only adds IP and User
           Agent to the cache for the current logged in user.
        -  No database tables are used. Instead WhosHere uses a proxy model of
           the User model.
        -  Proxy models will create migrations but do not affect your database
        
        Todo
        ----
        
        -  Add tests
        -  Think of other things to add
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
