https://github.com/necaris/python3-openid

Python 3 port of the python-openid library
https://github.com/necaris/python3-openid

openid python

Last synced: 6 days ago
JSON representation

Python 3 port of the python-openid library

• Host: GitHub
• URL: https://github.com/necaris/python3-openid
• Owner: necaris
• License: apache-2.0
• Created: 2012-12-03T20:01:17.000Z (about 12 years ago)
• Default Branch: main
• Last Pushed: 2024-02-26T15:48:16.000Z (10 months ago)
• Last Synced: 2024-09-19T09:48:07.278Z (4 months ago)
• Topics: openid, python
• Language: Python
• Size: 5.22 MB
• Stars: 46
• Watchers: 5
• Forks: 42
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
_NOTE_: This started out as a fork of the Python OpenID library, with changes

to make it Python 3 compatible. It's now a port of that library, including

cleanups and updates to the code in general.

[![Build Status](https://github.com/necaris/python3-openid/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/necaris/python3-openid/actions?query=branch%3Amain)

[![Coverage Status](https://coveralls.io/repos/necaris/python3-openid/badge.svg?branch=master&service=github)](https://coveralls.io/github/necaris/python3-openid?branch=master)

# requirements

- Python 3.5+ (tested on CPython 3.5-3.8, and PyPy3 (although some tests may fail on PyPy))

# installation

The recommended way is to install from PyPI with `pip`:

    pip install python3-openid

Alternatively, you can run the following command from a source checkout:

    python setup.py install

If you want to use MySQL or PostgreSQL storage options, be sure to install

the relevant "extra":

    pip install python3-openid[mysql]

# getting started

The library should follow the existing `python-openid` API as closely as possible.

_NOTE_: documentation will be auto-generated as soon as I can figure out how to

update the documentation tools.

_NOTE_: The examples directory includes an example server and consumer

implementation. See the README file in that directory for more

information on running the examples.

# logging

This library offers a logging hook that will record unexpected

conditions that occur in library code. If a condition is recoverable,

the library will recover and issue a log message. If it is not

recoverable, the library will raise an exception. See the

documentation for the `openid.oidutil` module for more on the logging

hook.

# documentation

The documentation in this library is in Epydoc format, which is

detailed at:

http://epydoc.sourceforge.net/

# contact

Bug reports, suggestions, and feature requests are [very welcome](../../issues)!

There are also the `#python-openid` and `#openid` channels on FreeNode IRC.

# contributors

- @necaris

- @moreati

- @vstoykov

- @earthday

- @bkmgit