Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #152

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 36 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
.. image:: https://img.shields.io/pypi/v/django-session-security.svg
:target: https://pypi.python.org/pypi/django-session-security

:alt: Latest version
.. image:: https://github.com/yourlabs/django-session-security/actions/workflows/tests.yml/badge.svg
:target: https://github.com/yourlabs/django-session-security/actions


:alt: Unit tests
.. image:: https://readthedocs.org/projects/django-session-security/badge/?version=latest
:target: https://django-session-security.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/pyversions/django-session-security.svg?style=flat-square
:target: https://pypi.python.org/pypi/django-session-security/
:alt: Supported python versions
.. image:: https://img.shields.io/pypi/l/django-session-security.svg?style=flat-square
:target: https://github.com/yourlabs/django-session-security/blob/master/LICENSE
:alt: License

Supported python versions
Python 3.8, 3.9, 3.10, 3.11
Supported django versions
Django 3.2, 4.0, 4.1

A little javascript and middleware work together to ensure that the user was
active during the past X minutes in any tab he has open.
Otherwise, display a warning leaving a couple of minutes to show any kind of
activity like moving the mouse. Otherwise, logout the user.

Documentation
-------------
https://django-session-security.readthedocs.io/

About
-----

This app provides a mechanism to logout inactive authenticated users. An
inactive browser should be logged out automatically if the user left his
Expand Down Expand Up @@ -62,7 +87,7 @@ more recent activity was not detected anywhere else - in any other browser tab.
Requirements
------------

- Python 2.7 or 3.5+
- Python 3.8+
- jQuery 1.7+
- Django 3.2 to 4.0
- django.contrib.staticfiles or #YoYo
Expand All @@ -77,15 +102,18 @@ package updates.
<https://github.com/yourlabs/django-session-security/>`_ by `GitHub
<http://github.com>`_,
- `Documentation graciously hosted
<http://django-session-security.rtfd.org>`_ by `RTFD
<http://rtfd.org>`_,
<https://django-session-security.readthedocs.io/>`_ by `Read the Docs
<https://readthedocs.io/>`_,
- `Package graciously hosted
<http://pypi.python.org/pypi/django-session-security/>`_ by `PyPi
<http://pypi.python.org/pypi>`_,
<https://pypi.python.org/pypi/django-session-security/>`_ by `PyPi
<https://pypi.python.org/pypi>`_,
- `Mailing list graciously hosted
<http://groups.google.com/group/yourlabs>`_ by `Google
<http://groups.google.com>`_
- For **Security** issues, please contact yourlabs-security@googlegroups.com
- `Continuous integration graciously hosted
<https://github.com/yourlabs/django-session-security/actions>`_ by `GitHub
<https://github.com>`_
- `Continuous integration historically hosted
<http://travis-ci.org/yourlabs/django-session-security>`_ by `Travis-ci
<http://travis-ci.org>`_
15 changes: 14 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,25 @@ def run(self):
'Development Status :: 5 - Production/Stable',
'Environment :: Web Environment',
'Framework :: Django',
'Framework :: Django :: 1.8',
'Framework :: Django :: 1.9',
'Framework :: Django :: 1.10',
'Framework :: Django :: 1.11',
'Framework :: Django :: 2',
'Framework :: Django :: 2.2',
'Framework :: Django :: 3',
'Framework :: Django :: 3.2',
'Framework :: Django :: 4',
'Framework :: Django :: 4.0',
'Framework :: Django :: 4.1',
'Intended Audience :: Developers',
'License :: OSI Approved :: MIT License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Topic :: Internet :: WWW/HTTP',
'Topic :: Software Development :: Libraries :: Python Modules',
]
Expand Down
Loading