Skip to main content

A generic Django app to login via Helmholtz AAI

Project description

Helmholtz AAI Django App

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 model based upon djangos User model and derived from the Helmholtz AAI
  • a new HelmholtzVirtualOrganization model 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 and examples provided there.

Installation

Install this package in a dedicated python environment via

python -m venv venv
source venv/bin/activate
pip install django-helmholtz-aai

To use this in a development setup, clone the source code from gitlab, start the development server and make your changes::

git clone https://codebase.helmholtz.cloud/hcdc/django/django-helmholtz-aai
cd django-helmholtz-aai
python -m venv venv
source venv/bin/activate
make dev-install

More detailed installation instructions my be found in the docs.

Technical note

This package has been generated from the template https://codebase.helmholtz.cloud/hcdc/software-templates/django-app-template.git.

See the template repository for instructions on how to update the skeleton for this package.

License information

Copyright © 2022-2023 Helmholtz-Zentrum hereon GmbH

Code files in this repository are licensed under the EUPL-1.2, if not stated otherwise in the file.

Documentation files in this repository are licensed under CC-BY-4.0, if not stated otherwise in the file.

Supplementary and configuration files in this repository are licensed under CC0-1.0, if not stated otherwise in the file.

Please check the header of the individual files for more detailed information.

License management

License management is handled with reuse. If you have any questions on this, please have a look into the contributing guide or contact the maintainers of django-helmholtz-aai.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_helmholtz_aai-0.2.0.tar.gz (50.6 kB view hashes)

Uploaded Source

Built Distribution

django_helmholtz_aai-0.2.0-py3-none-any.whl (66.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page