Keep track of failed login attempts in Django-powered sites.
Find a file
Aleksi Häkli 12a806be28
Update author and licence information
Add Jazzband as maintainer from 2016 onwards when the
project started receiving contributions from Jazzband.

Fixes #409
2019-03-13 16:56:56 +02:00
axes Remove reduntant AccessLog.trusted flag 2019-03-13 16:07:25 +02:00
docs Set Axes request attributes in middleware 2019-03-03 22:13:13 +02:00
.coveragerc Update test runner script and versions 2019-02-03 16:03:29 +02:00
.gitignore Introduce gradual typing with mypy 2019-02-13 01:14:26 +02:00
.prospector.yaml Run more comprehensive prospector checks 2019-02-12 23:33:18 +02:00
.pyup.yml create pyup.io config file 2019-01-20 18:10:20 +02:00
.travis.yml Remove Python 3.5 from Travis test matrix 2019-03-09 21:57:52 +02:00
CHANGES.rst Update changelog with handler information 2019-02-24 22:53:53 +02:00
codecov.yml Raise minimum test coverage to 90% 2019-02-10 19:22:13 +02:00
LICENSE Update author and licence information 2019-03-13 16:56:56 +02:00
manage.py Use pytest for test runner 2019-02-20 23:05:21 +02:00
MANIFEST.in Change suffix on changes to .rst 2019-02-24 22:45:39 +02:00
mypy.ini Drop Python 3.5 support 2019-03-09 21:49:45 +02:00
pytest.ini Run coverage with pytest 2019-02-22 08:30:11 +02:00
README.rst Improve README language 2019-03-02 23:09:31 +02:00
requirements.txt Upgrade pytest from 4.3.0 to 4.3.1 2019-03-13 15:59:56 +02:00
setup.py Update author and licence information 2019-03-13 16:56:56 +02:00
tox.ini Run mypy on all tox environments 2019-03-09 21:52:25 +02:00

Django Axes
===========

.. image:: https://jazzband.co/static/img/badge.svg
   :target: https://jazzband.co/
   :alt: Jazzband

.. image:: https://img.shields.io/github/stars/jazzband/django-axes.svg?label=Stars&style=socialcA
   :target: https://github.com/jazzband/django-axes
   :alt: GitHub

.. image:: https://img.shields.io/pypi/v/django-axes.svg
   :target: https://pypi.org/project/django-axes/
   :alt: PyPI release

.. image:: https://img.shields.io/readthedocs/django-axes.svg
   :target: https://django-axes.readthedocs.io/
   :alt: Documentation

.. image:: https://secure.travis-ci.org/jazzband/django-axes.svg?branch=master
   :target: http://travis-ci.org/jazzband/django-axes
   :alt: Build Status

.. image:: https://codecov.io/gh/jazzband/django-axes/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/jazzband/django-axes
   :alt: Coverage

.. image:: https://pyup.io/repos/github/jazzband/django-axes/shield.svg
   :target: https://pyup.io/repos/github/jazzband/django-axes/
   :alt: Updates


Axes is a very simple way for you to keep track of failed
login attempts for your login and administration views.

The name is sort of a geeky pun, since it can be interpreted as:

* ``access``, as in monitoring access attempts, or
* ``axes``, as in tools you can use hack (generally on wood).

In this case, however, the hacking part of it can be taken a bit further:
Axes is intended to help you *stop* people from hacking the website.


Functionality
-------------

Axes records login attempts to your Django powered site and prevents attackers
from brute forcing the site when they exceed the configured attempt limit.

Axes can track the attempts and persist them in the database indefinitely,
or alternatively use a fast and DDoS resistant cache implementation.

Axes can be configured to monitor login attempts by
IP address, username, user agent, or their combinations.

Axes supports cool off periods, IP address whitelisting and blacklisting,
user account whitelisting, and other features for Django access management.


Documentation
-------------

For more information on installation and configuration see the documentation at:

https://django-axes.readthedocs.io/


Issues
------

If you have questions or have trouble using the app please file a bug report at:

https://github.com/jazzband/django-axes/issues


Contributions
-------------

This is a `Jazzband <https://jazzband.co>`_ project.
By contributing you agree to abide by the
`Contributor Code of Conduct <https://jazzband.co/about/conduct>`_
and follow the `guidelines <https://jazzband.co/about/guidelines>`_.

It is best to separate proposed changes and PRs into small, distinct patches
by type so that they can be merged faster into upstream and released quicker:

* features,
* bugfixes,
* code style improvements, and
* documentation improvements.