README.md
1_NOTE_: This started out as a fork of the Python OpenID library, with changes
2to make it Python 3 compatible. It's now a port of that library, including
3cleanups and updates to the code in general.
4
5[](https://travis-ci.org/necaris/python3-openid)
6[](https://coveralls.io/github/necaris/python3-openid?branch=master)
7
8# requirements
9
10- Python 3.5+ (tested on CPython 3.5-3.8, and PyPy3 (although some tests may fail on PyPy))
11
12# installation
13
14The recommended way is to install from PyPI with `pip`:
15
16 pip install python3-openid
17
18Alternatively, you can run the following command from a source checkout:
19
20 python setup.py install
21
22If you want to use MySQL or PostgreSQL storage options, be sure to install
23the relevant "extra":
24
25 pip install python3-openid[mysql]
26
27# getting started
28
29The library should follow the existing `python-openid` API as closely as possible.
30
31_NOTE_: documentation will be auto-generated as soon as I can figure out how to
32update the documentation tools.
33
34_NOTE_: The examples directory includes an example server and consumer
35implementation. See the README file in that directory for more
36information on running the examples.
37
38# logging
39
40This library offers a logging hook that will record unexpected
41conditions that occur in library code. If a condition is recoverable,
42the library will recover and issue a log message. If it is not
43recoverable, the library will raise an exception. See the
44documentation for the `openid.oidutil` module for more on the logging
45hook.
46
47# documentation
48
49The documentation in this library is in Epydoc format, which is
50detailed at:
51
52http://epydoc.sourceforge.net/
53
54# contact
55
56Bug reports, suggestions, and feature requests are [very welcome](issues)!
57
58There are also the `#python-openid` and `#openid` channels on FreeNode IRC.
59
60# contributors
61
62- @necaris
63- @moreati
64- @vstoykov
65- @earthday
66- @bkmgit
67
){kind=link}
){kind=link}