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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file django_helmholtz_aai-0.2.0.tar.gz.

File metadata

  • Download URL: django_helmholtz_aai-0.2.0.tar.gz
  • Upload date:
  • Size: 50.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for django_helmholtz_aai-0.2.0.tar.gz
Algorithm Hash digest
SHA256 9849f93016fcf8ab6cd1894bca14d1149a39bf2e950bc78ee0ea26bb9e8e67b6
MD5 aba7480954d7233bf0521623c80009dc
BLAKE2b-256 e521edc117dfa283e16d3b6011feebc6cb9f516ae9b8581adba7c90aaa7efdf7

See more details on using hashes here.

File details

Details for the file django_helmholtz_aai-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_helmholtz_aai-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b5beeb587db26fd69c0ad7435135d19185482a02b4300804eb0f59cf82f74b6
MD5 fcae4dc00658c37a041fd5122bdeea21
BLAKE2b-256 8f017682bcde664db163f93013c733c1c677a5218f0df1851ad1aab0b71d11be

See more details on using hashes here.

Supported by

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