Keep track of failed login attempts in Django-powered sites.
Find a file
dependabot-preview[bot] d76cd5e4e3 Bump coverage from 5.2.1 to 5.3
Bumps [coverage](https://github.com/nedbat/coveragepy) from 5.2.1 to 5.3.
- [Release notes](https://github.com/nedbat/coveragepy/releases)
- [Changelog](https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst)
- [Commits](https://github.com/nedbat/coveragepy/compare/coverage-5.2.1...coverage-5.3)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-09-14 09:35:31 +00:00
axes Deprecate django-appconf 2020-09-12 17:03:50 +03:00
docs Changed url() to path() 2020-09-10 21:21:32 +03:00
.coveragerc Update test runner script and versions 2019-02-03 16:03:29 +02:00
.gitignore Add pip-wheel-metadata to .gitignores 2019-08-30 07:28:37 +03:00
.prospector.yaml Upgrade CI tooling to use automatic code formatting 2019-09-28 19:28:17 +03:00
.travis.yml Added Django 3.1 test environment. 2020-08-06 10:44:53 +03:00
CHANGES.rst Version 5.6.0 2020-09-12 17:06:49 +03: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 PEP8 formatting 2019-10-15 23:04:29 +03:00
MANIFEST.in Include rst docs to the package manifest 2019-05-01 15:53:26 +03:00
mypy.ini Drop Python 3.5 support 2019-03-09 21:49:45 +02:00
pyproject.toml Migrate to setuptools_scm 2019-08-28 13:28:57 +03:00
pytest.ini Run coverage with pytest 2019-02-22 08:30:11 +02:00
README.rst Improve README structuring 2020-09-13 16:12:38 +03:00
requirements.txt Bump coverage from 5.2.1 to 5.3 2020-09-14 09:35:31 +00:00
setup.py Deprecate django-appconf 2020-09-12 17:03:50 +03:00
tox.ini Added Django 3.1 test environment. 2020-08-06 10:44:53 +03: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


Axes is a Django plugin for keeping track of suspicious
login attempts for your Django based website
and implementing simple brute-force attack blocking.

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 to hack (generally on wood).


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

Axes records login attempts to your Django powered site and prevents attackers
from attempting further logins to your 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
-------------

All contributions are welcome!

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.

One way to organize contributions would be to separate PRs for e.g.

* bugfixes,
* new features,
* code and design improvements,
* documentation improvements, or
* tooling and CI improvements.

Merging contributions requires passing the checks configured
with the CI. This includes running tests and linters successfully
on the currently officially supported Python and Django versions.

The test automation is run automatically by Travis CI, but you can
run it locally with the ``tox`` command before pushing commits.

Please note that 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>`_.