README.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. django-axes
  2. ===========
  3. .. image:: https://jazzband.co/static/img/badge.svg
  4. :target: https://jazzband.co/
  5. :alt: Jazzband
  6. .. image:: https://img.shields.io/github/stars/jazzband/django-axes.svg?label=Stars&style=socialcA
  7. :target: https://github.com/jazzband/django-axes
  8. :alt: GitHub
  9. .. image:: https://img.shields.io/pypi/v/django-axes.svg
  10. :target: https://pypi.org/project/django-axes/
  11. :alt: PyPI release
  12. .. image:: https://img.shields.io/readthedocs/django-axes.svg
  13. :target: https://django-axes.readthedocs.io/
  14. :alt: Documentation
  15. .. image:: https://github.com/jazzband/django-axes/workflows/Test/badge.svg
  16. :target: https://github.com/jazzband/django-axes/actions
  17. :alt: GitHub Actions
  18. .. image:: https://codecov.io/gh/jazzband/django-axes/branch/master/graph/badge.svg
  19. :target: https://codecov.io/gh/jazzband/django-axes
  20. :alt: Coverage
  21. Axes is a Django plugin for keeping track of suspicious
  22. login attempts for your Django based website
  23. and implementing simple brute-force attack blocking.
  24. The name is sort of a geeky pun, since it can be interpreted as:
  25. * ``access``, as in monitoring access attempts, or
  26. * ``axes``, as in tools you can use to hack (generally on wood).
  27. Functionality
  28. -------------
  29. Axes records login attempts to your Django powered site and prevents attackers
  30. from attempting further logins to your site when they exceed the configured attempt limit.
  31. Axes can track the attempts and persist them in the database indefinitely,
  32. or alternatively use a fast and DDoS resistant cache implementation.
  33. Axes can be configured to monitor login attempts by
  34. IP address, username, user agent, or their combinations.
  35. Axes supports cool off periods, IP address whitelisting and blacklisting,
  36. user account whitelisting, and other features for Django access management.
  37. Documentation
  38. -------------
  39. For more information on installation and configuration see the documentation at:
  40. https://django-axes.readthedocs.io/
  41. Issues
  42. ------
  43. If you have questions or have trouble using the app please file a bug report at:
  44. https://github.com/jazzband/django-axes/issues
  45. Contributions
  46. -------------
  47. All contributions are welcome!
  48. It is best to separate proposed changes and PRs into small, distinct patches
  49. by type so that they can be merged faster into upstream and released quicker.
  50. One way to organize contributions would be to separate PRs for e.g.
  51. * bugfixes,
  52. * new features,
  53. * code and design improvements,
  54. * documentation improvements, or
  55. * tooling and CI improvements.
  56. Merging contributions requires passing the checks configured
  57. with the CI. This includes running tests and linters successfully
  58. on the currently officially supported Python and Django versions.
  59. The test automation is run automatically with GitHub Actions, but you can
  60. run it locally with the ``tox`` command before pushing commits.
  61. Please note that this is a `Jazzband <https://jazzband.co>`_ project.
  62. By contributing you agree to abide by the
  63. `Contributor Code of Conduct <https://jazzband.co/about/conduct>`_
  64. and follow the `guidelines <https://jazzband.co/about/guidelines>`_.