README.rst 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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/pypi/v/django-axes.svg
  7. :target: https://pypi.org/project/django-axes/
  8. :alt: PyPI release
  9. .. image:: https://img.shields.io/readthedocs/django-axes.svg
  10. :target: https://django-axes.readthedocs.io/
  11. :alt: Documentation
  12. .. image:: https://secure.travis-ci.org/jazzband/django-axes.svg?branch=master
  13. :target: http://travis-ci.org/jazzband/django-axes
  14. :alt: Build Status
  15. .. image:: https://codecov.io/gh/jazzband/django-axes/branch/master/graph/badge.svg
  16. :target: https://codecov.io/gh/jazzband/django-axes
  17. :alt: Coverage
  18. .. image:: https://img.shields.io/github/stars/jazzband/django-axes.svg?label=Stars&style=socialcA
  19. :target: https://github.com/jazzband/django-axes
  20. :alt: GitHub
  21. ``django-axes`` is a very simple way for you to keep track of failed login
  22. attempts, both for the Django admin and for the rest of your site. The name is
  23. sort of a geeky pun, since ``axes`` can be read interpreted as:
  24. * "access", as in monitoring access attempts
  25. * "axes", as in tools you can use hack (generally on wood). In this case,
  26. however, the "hacking" part of it can be taken a bit further: ``django-axes``
  27. is intended to help you *stop* people from hacking (popular media
  28. definition) your website. Hilarious, right? That's what I thought too!
  29. Documentation
  30. -------------
  31. For more information see the documentation at:
  32. https://django-axes.readthedocs.io/
  33. Issues
  34. ------
  35. If you have questions or have trouble using the app please file a bug report at:
  36. https://github.com/jazzband/django-axes/issues
  37. Contributing
  38. ------------
  39. Separate proposed changes and PRs into small, distinct patches by type
  40. so that they can be merged faster into upstream and released quicker:
  41. * Feature
  42. * Bugfix
  43. * Code style
  44. * Documentation