authentic2-auth-fedict
======================

Authentic2 plugin to authenticate against the Belgian Federal Authentication
Service provided by Fedict.

Installation
------------

Install with `pip install authentic2-auth-fedict`

Settings
========

Add `A2_AUTH_FEDICT_ENABLE = True` to your `local_settings.py` file and define
the django-mellon adapter:

  MELLON_ADAPTER = ('authentic2_auth_fedict.adapters.AuthenticAdapter',)

And appropriate django-mellon parameters (MELLON_PUBLIC_KEYS,
MELLON_PRIVATE_KEY, MELLON_IDENTITY_PROVIDERS).

You also have to register the plugin:

  INSTALLED_APPS += ('authentic2_auth_fedict')
  AUTHENTICATION_BACKENDS += ('authentic2_auth_fedict.backends.FedictBackend',)


Code Style
----------

black is used to format the code, using thoses parameters:

    black --target-version py37 --skip-string-normalization --line-length 110

isort is used to format the imports, using those parameter:

    isort --profile black --line-length 110

pyupgrade is used to automatically upgrade syntax, using those parameters:

    pyupgrade --keep-percent-format --py37-plus

There is .pre-commit-config.yaml to use pre-commit to automatically run black,
isort and pyupgrade before commits. (execute `pre-commit install` to install
the git hook.)


License
-------

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.