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