File	Date	Author	Commit
auth	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
fixtures	2009-06-29	Serge Matveenko	[f9fdda] Revert "Fix google openid provider url"
locale	2009-06-25	Serge Matveenko	[2196c1] Add translations: English, Russian
templates	2009-06-25	Serge Matveenko	[332ef9] Update login.html template
views	2009-10-13	Serge Matveenko	[3738d6] Merge branch 'master' of ssh://sergematveenko@...
.gitignore	2009-06-25	Serge Matveenko	[ebb431] Add .gitignore
COPYING	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
README	2009-10-13	Serge Matveenko	[3738d6] Merge branch 'master' of ssh://sergematveenko@...
VERSION	2009-10-13	Serge Matveenko	[2a5f9d] Update VERSION to 1.1.2
__init__.py	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
admin.py	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
forms.py	2009-10-13	Serge Matveenko	[3738d6] Merge branch 'master' of ssh://sergematveenko@...
managers.py	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
models.py	2009-06-25	Serge Matveenko	[aa67bc] Merge commit 'hata/master'
settings_sample.py	2009-10-13	Serge Matveenko	[3738d6] Merge branch 'master' of ssh://sergematveenko@...
store.py	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
tests.py	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder
urls.py	2009-06-25	Serge Matveenko	[36f37a] Working over js for pretty form
urls_sample.py	2009-06-25	Serge Matveenko	[e5c1a6] Move all files to root lib folder

Read Me

This is short developer instructions for django-simpleopenid library.
Project home page: http://lig.github.com/simpleopenid

To use django-simpleopenid you must add following in your Django settings
module:

""" You must have AuthenticationMiddleware enabled """
MIDDLEWARE_CLASSES = (
    'django.middleware.common.CommonMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'core.middleware.NoSelfLinksMiddleware',
)

""" You must add 'simpleopenid' to installed apps. Feel free to put it into
any folder or even rename its folder. """
INSTALLED_APPS = (
    'simpleopenid',
)

""" You must add 'simpleopenid.auth.backends.OpenIDBackend' to your
authentication backedns. You must provide default ModelBackend explicit to
let work ordinary user/password authentication work. """
AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend',
    'simpleopenid.auth.backends.OpenIDBackend',
)

Then you must run 'python manage.py syncdb' in your project folder.


After setting up django-simpleopenid you could use it in several ways:

1. Add urls patterns from urls_sample/py file to your urls.py and use form
classes from simpleopenid.forms to authenticate users. All forms return
redirect to user profile on success or to 'index' url on fail.
New users are creating automaticaly.
There are url named 'openid-login' that you could use as entry point.
You might need to make your own 'openid/login.html' template using
'openid_login_form' template variable for form instance.

2. Use 'contrib.auth.authenticate' in to steps. Look into docstrings of the
'simpleopenid.auth.backends.OpenIDBackend.authenticate' method for more
info.