README 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. This is the Python OpenID library.
  2. REQUIREMENTS
  3. ============
  4. - Python 2.3, 2.4, or 2.5.
  5. - ElementTree. This is included in the Python 2.5 standard library,
  6. but users of earlier versions of Python may need to install it
  7. seperately.
  8. - pycrypto, if on Python 2.3 and without /dev/urandom, or on Python
  9. 2.3 or 2.4 and you want SHA256.
  10. INSTALLATION
  11. ============
  12. To install the base library, just run the following command:
  13. python setup.py install
  14. To run setup.py you need the distutils module from the Python standard
  15. library; some distributions package this seperately in a "python-dev"
  16. package.
  17. GETTING STARTED
  18. ===============
  19. The examples directory includes an example server and consumer
  20. implementation. See the README file in that directory for more
  21. information on running the examples.
  22. Library documentation is available in html form in the doc directory.
  23. LOGGING
  24. =======
  25. This library offers a logging hook that will record unexpected
  26. conditions that occur in library code. If a condition is recoverable,
  27. the library will recover and issue a log message. If it is not
  28. recoverable, the library will raise an exception. See the
  29. documentation for the openid.oidutil module for more on the logging
  30. hook.
  31. DOCUMENTATION
  32. =============
  33. The documentation in this library is in Epydoc format, which is
  34. detailed at:
  35. http://epydoc.sourceforge.net/
  36. CONTACT
  37. =======
  38. Send bug reports, suggestions, comments, and questions to
  39. http://openid.net/developers/dev-mailing-lists/.
  40. If you have a bugfix or feature you'd like to contribute, don't
  41. hesitate to send it to us. For more detailed information on how to
  42. contribute, see
  43. http://openidenabled.com/contribute/