index.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. .. _index:
  2. ***************************************************
  3. :mod:`repoze.who` -- WSGI Authentication Middleware
  4. ***************************************************
  5. :Author: Chris McDonough / Tres Seaver
  6. :Version: |version|
  7. .. module:: repoze.who
  8. :synopsis: WSGI authentication middleware
  9. .. topic:: Overview
  10. :mod:`repoze.who` is an identification and authentication framework
  11. for arbitrary WSGI applications. It can be used as WSGI middleware,
  12. or as an API from within a WSGI application.
  13. :mod:`repoze.who` is inspired by Zope 2's Pluggable Authentication
  14. Service (PAS) (but :mod:`repoze.who` is not dependent on Zope in any
  15. way; it is useful for any WSGI application). It provides no
  16. facility for authorization (ensuring whether a user can or cannot
  17. perform the operation implied by the request). This is considered
  18. to be the domain of the WSGI application.
  19. It attempts to reuse implementations from ``paste.auth`` for some
  20. of its functionality.
  21. Sections
  22. ========
  23. .. toctree::
  24. :maxdepth: 2
  25. narr
  26. use_cases
  27. middleware
  28. api
  29. configuration
  30. plugins
  31. Change History
  32. ==============
  33. .. toctree::
  34. :maxdepth: 2
  35. changes
  36. Support and Development
  37. =======================
  38. To report bugs, use the `Repoze bug tracker <http://bugs.repoze.org>`_.
  39. If you've got questions that aren't answered by this documentation,
  40. contact the `Repoze-dev maillist
  41. <http://lists.repoze.org/listinfo/repoze-dev>`_ or join the `#repoze
  42. IRC channel <irc://irc.freenode.net/#repoze>`_.
  43. Browse and check out tagged and trunk versions of :mod:`repoze.who`
  44. via the `Repoze github repository
  45. <https://github.com/repoze/repoze.who/>`_. To check out the trunk
  46. via git, use this command::
  47. git clone https://github.com:repoze/repoze.who.git
  48. Or, if you are logged in:
  49. git clone git@github.com:repoze/repoze.who.git
  50. To find out how to become a contributor to :mod:`repoze.who`, please
  51. see the `contributor's page <http://repoze.org/contributing.html>`_.
  52. Indices and tables
  53. ==================
  54. * :ref:`genindex`
  55. * :ref:`modindex`
  56. * :ref:`search`