Metadata-Version: 2.1
Name: django-qsessions
Version: 0.2.1
Summary: Extends Django's cached_db session backend
Home-page: https://github.com/QueraTeam/django-qsessions
Author: Mohammad Javad Naderi
License: MIT
Download-URL: https://pypi.python.org/pypi/django-qsessions
Description: .. image:: https://user-images.githubusercontent.com/2115303/35397912-f00efbb4-0205-11e8-89b5-3d4f585a4588.png
        
        .. image:: https://img.shields.io/pypi/v/django-qsessions.svg
           :target: https://pypi.python.org/pypi/django-qsessions/
        
        .. image:: https://img.shields.io/travis/QueraTeam/django-qsessions.svg
           :target: https://travis-ci.org/QueraTeam/django-qsessions
        
        .. image:: https://img.shields.io/github/license/QueraTeam/django-qsessions.svg
           :target: https://github.com/QueraTeam/django-qsessions/blob/master/LICENSE.txt
        
        -------
        
        django-qsessions is a session backend for Django that extends Django's ``cached_db`` session backend
        and ``Session`` model to add following features:
        
        - Sessions have a foreign key to User
        
        - Sessions store IP and User Agent
        
        
        Comparison
        ==========
        
        Here is a brief comparison between Django's session backends (db, cache, cached_db), `django-user-sessions`_, and django-qsessions.
        
        +-------------------------+----+--------+-----------+----------------------+------------------+
        |                         | db | cache  | cached_db | django-user-sessions | django-qsessions |
        +=========================+====+========+===========+======================+==================+
        | Better Performance      |    | ✔✔     | ✔         |                      | ✔                |
        +-------------------------+----+--------+-----------+----------------------+------------------+
        | Persistent              | ✔  |        | ✔         | ✔                    | ✔                |
        +-------------------------+----+--------+-----------+----------------------+------------------+
        | Foreign Key to User     |    |        |           | ✔                    | ✔                |
        +-------------------------+----+--------+-----------+----------------------+------------------+
        | Store IP and User Agent |    |        |           | ✔                    | ✔                |
        +-------------------------+----+--------+-----------+----------------------+------------------+
        
        
        
        
        Compatibility
        =============
        
        +----------------+---------------------------+
        | Python version | Django versions           |
        +================+===========================+
        | 3.7            | 2.0, 2.1, 2.2             |
        +----------------+---------------------------+
        | 3.6            | 1.10, 1.11, 2.0, 2.1, 2.2 |
        +----------------+---------------------------+
        | 3.5            | 1.10, 1.11, 2.0, 2.1, 2.2 |
        +----------------+---------------------------+
        | 3.4            | 1.10, 1.11, 2.0           |
        +----------------+---------------------------+
        | 2.7            | 1.10, 1.11                |
        +----------------+---------------------------+
        
        Installation
        ============
        
        Please note that if your system is in production and there are lots of active sessions
        using another session backend, you need to migrate them manually. We have no migration script.
        
        (1) First, make sure you've `configured your cache`_. If you have multiple caches defined in
            ``CACHES``, Django will use the default cache. To use another cache, set ``SESSION_CACHE_ALIAS``
            to the name of that cache.
        
        (2) Install the latest version from PyPI:
        
            .. code-block:: sh
        
                pip install django-qsessions
        
        (3) In settings:
        
            - In ``INSTALLED_APPS`` replace ``'django.contrib.sessions'`` with ``'qsessions'``.
        
            - In ``MIDDLEWARE`` or ``MIDDLEWARE_CLASSES`` replace
              ``'django.contrib.sessions.middleware.SessionMiddleware'`` with
              ``'qsessions.middleware.SessionMiddleware'``.
        
            - Set ``SESSION_ENGINE`` to ``'qsessions.backends.cached_db'``.
        
        (4) Run migrations to create ``qsessions.models.Session`` model.
        
            .. code-block:: sh
        
                python manage.py migrate qsessions
        
        For enabling location detection using GeoIP2 (optional):
        
        (5) Install ``geoip2`` package:
        
            .. code-block:: sh
        
                pip install geoip2
        
        (6) Set ``GEOIP_PATH`` to a directory for storing GeoIP2 database.
        
        (7) Run the following command to download latest GeoIP2 database. You can add this command to a cron
            job to update GeoIP2 DB automatically.
        
            .. code-block:: sh
        
                python manage.py download_geoip_db
        
        Usage
        =====
        
        django-qsessions has a custom ``Session`` model with following fields:
        ``user``, ``user_agent``, ``created_at``, ``updated_at``, ``ip``.
        
        Getting a user's sessions:
        
        .. code-block:: python
        
            user.session_set.filter(expire_date__gt=timezone.now())
        
        Deleting a session:
        
        .. code-block:: python
        
            # Deletes session from both DB and cache
            session.delete()
        
        Logout a user:
        
        .. code-block:: python
        
            user.session_set.all().delete()
        
        Session creation time (user login time):
        
        .. code-block:: python
        
            >>> session.created_at
            datetime.datetime(2018, 6, 12, 17, 9, 17, 443909, tzinfo=<UTC>)
        
        
        IP and user agent:
        
        .. code-block:: python
        
            >>> session.ip
            '127.0.0.1'
            >>> session.user_agent
            'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/65.0.3325.181 Safari/537.36'
        
        And if you have configured GeoIP2, you can call ``.location()``, ``.location_info()``:
        
        .. code-block:: python
        
            >>> session.location()
            'Tehran, Iran'
        
            >>> session.location_info()
            {'city': 'Tehran', 'continent_code': 'AS', 'continent_name': 'Asia', 'country_code': 'IR', 'country_name': 'Iran', 'time_zone': 'Asia/Tehran', ...}
        
        Admin page:
        
        .. image:: https://user-images.githubusercontent.com/2115303/41525284-b0b258b0-72f5-11e8-87f1-8770e0094f4c.png
        
        Caveats
        -------
        
        - ``session.updated_at`` is not the session's last activity. It's updated each time the session
          object in DB is saved. (e.g. when user logs in, or when ip, user agent, or session data changes)
        
        Why not ``django-user-sessions``?
        =================================
        
        `django-user-sessions`_ has the same functionality,
        but it's based on ``db`` backend. Using a cache will improve performance.
        
        We got ideas and some codes from django-user-sessions.
        Many thanks to `Bouke Haarsma`_ for writing django-user-sessions.
        
        Development
        ===========
        
        * Install development dependencies in your virtualenv with ``pip install -e '.[dev]'``
        * Run tests with coverage using ``py.test --cov .``
        
        
        TODO
        ====
        
        - Write better documentation.
        
          - Explain how it works (in summary)
          - Add more details to existing documentation.
        
        - Write more tests
        
        - Performance benchmark (and compare with Django's ``cached_db``)
        
        Contributions are welcome!
        
        License
        =======
        
        MIT
        
        .. _`configured your cache`: https://docs.djangoproject.com/en/dev/topics/cache/
        .. _`django-user-sessions`: https://github.com/Bouke/django-user-sessions
        .. _`Bouke Haarsma`: https://github.com/Bouke
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP :: Session
Classifier: Topic :: Security
Provides-Extra: dev
