DGNum/django-allauth-ens
6
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

Better README display?

Browse source
This commit is contained in:
Evarin 2018-06-03 22:15:16 +02:00
parent 17fef409a8
commit 5ee1c774ac
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -179,15 +179,17 @@ Configuration
Set ``SOCIALACCOUNT_ADAPTER='allauth_ens.adapter.LongTermClipperAccountAdapter'`` Set ``SOCIALACCOUNT_ADAPTER='allauth_ens.adapter.LongTermClipperAccountAdapter'``
in `settings.py` in `settings.py`
Auto-signup Auto-signup
Populated data Populated data
- username: ``<clipper>@<entrance year>`` - username: ``<clipper>@<entrance year>``
- email: from LDAP's *mailRoutingAddress* field, or ``<clipper>@clipper.ens.fr`` - email: from LDAP's *mailRoutingAddress* field, or ``<clipper>@clipper.ens.fr``
- first_name, last_name from LDAP's *cn* field - first_name, last_name from LDAP's *cn* field
- extra_data in SocialAccount instance, containing these field, plus *annee* - extra_data in SocialAccount instance, containing these field, plus *annee*
and *promotion* parsed from LDAP's *homeDirectory* field (available only on and *promotion* parsed from LDAP's *homeDirectory* field (available only on
first connection) first connection)
Account deprecation Account deprecation
At the beginning of each year (i.e. early November), to prevent clipper At the beginning of each year (i.e. early November), to prevent clipper
username conflicts, you should run ``$ python manage.py deprecate_clippers``. username conflicts, you should run ``$ python manage.py deprecate_clippers``.
@ -196,6 +198,7 @@ Account deprecation
(using LDAP), so that a known user keeps his account, but a newcomer won't (using LDAP), so that a known user keeps his account, but a newcomer won't
inherit an archicube's. inherit an archicube's.
Customize Customize
You can customize the SocialAccountAdapter by inheriting You can customize the SocialAccountAdapter by inheriting
``allauth_ens.adapter.LongTermClipperAccountAdapter``. You might want to ``allauth_ens.adapter.LongTermClipperAccountAdapter``. You might want to
@ -206,6 +209,7 @@ Customize
``get_username`` (as done in the example website) allows to get rid of that ``get_username`` (as done in the example website) allows to get rid of that
behaviour, and for instance attribute a default entrance year. behaviour, and for instance attribute a default entrance year.
Initial migration Initial migration
If you used allauth without LongTermClipperAccountAdapter, or another CAS If you used allauth without LongTermClipperAccountAdapter, or another CAS
interface to log in, you need to update the Users to the new username policy, interface to log in, you need to update the Users to the new username policy,