Welcome to django-helmholtz-aai’s documentation!

CI Code coverage Docs Latest Release PyPI version Code style: black Imports: isort PEP8 Checked with mypy REUSE status

A generic Django app to login via Helmholtz AAI

Features

Features include

  • ready-to-use views for authentification against the Helmholtz AAI

  • a new HelmholtzUser class based upon djangos User model and derived from the Helmholtz AAI

  • a new HelmholtzVirtualOrganization class based upon djangos Group model and derived from the Helmholtz AAI

  • several signals to handle the login of Helmholtz AAI user for your specific application

  • automated synchronization of VOs of on user authentification

Get started by following the installation instructions and have a look into the Configuration options.

How to cite this software

Please do cite this software!

Philipp S. P.S., Housam H., Hatef H. Helmholtz AAI Django App URL: https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai

@misc{YourReferenceHere,
author = {Philipp S., Philipp S. and Housam, Housam and Hatef, Hatef},
title = {Helmholtz AAI Django App},
url = {https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai}
}

TY  - GEN
AB  - A generic Django app to login via Helmholtz AAI

AU  - Philipp S., Philipp S.
AU  - Housam, Housam
AU  - Hatef, Hatef
KW  - Helmholtz AAI
KW  - authlib
KW  - oauth
KW  - hifis
KW  - login
KW  - hgf
TI  - Helmholtz AAI Django App
UR  - https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai
ER

%0 Generic
%A Philipp S., Philipp S.
%A Housam, Housam
%A Hatef, Hatef
%K Helmholtz AAI
%K authlib
%K oauth
%K hifis
%K login
%K hgf
%T Helmholtz AAI Django App
%U https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai

# SPDX-FileCopyrightText: 2022-2023 Helmholtz-Zentrum hereon GmbH
#
# SPDX-License-Identifier: CC0-1.0

authors:
  # list author information. see
  # https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsperson
  # for metadata
  - family-names: "Philipp S."
    given-names: "Philipp S."
    affiliation: "Helmholtz-Zentrum Hereon"
    # orcid: null
    email: "philipp.sommer@hereon.de"
  - family-names: "Housam"
    given-names: "Housam"
    affiliation: "Helmholtz-Zentrum Hereon"
    # orcid: null
    email: "hcdc_support@hereon.de"
  - family-names: "Hatef"
    given-names: "Hatef"
    affiliation: "Helmholtz-Zentrum Hereon"
    # orcid: null
    email: "hcdc_support@hereon.de"
cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
title: "Helmholtz AAI Django App"
keywords:
  - "Helmholtz AAI"

  - "authlib"

  - "oauth"

  - "hifis"

  - "login"

  - "hgf"

license: 'EUPL-1.2'
repository-code: "https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai"
url: "https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai"
contact:
  # list maintainer information. see
  # https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#definitionsperson
  # for metadata
  - family-names: "Philipp S."
    given-names: "Philipp S."
    affiliation: "Helmholtz-Zentrum Hereon"
    # orcid: null
    email: "philipp.sommer@hereon.de"
abstract: |
  A generic Django app to login via Helmholtz AAI

License information

Copyright © 2022-2023 Helmholtz-Zentrum hereon GmbH

The source code of django-helmholtz-aai is licensed under EUPL-1.2.

If not stated otherwise, the contents of this documentation is licensed under CC-BY-4.0.

Indices and tables