CDH Django libraries

A collection of Django apps for CDH Django projects. Developed by the ILS Labs and the Humanities IT Portal Development and Support Team

Documentation provided here: https://centrefordigitalhumanities.github.io/django-shared-core/

Currently targeting:

• Python 3.9 (Django 4 only)
• Python 3.11
• Django 4.2
• Django 5.0

Tests are run using these versions; Some apps have lower requirements, but are not tested against these lower versions. check the app collection below for specifics.

Installing

Quick

Add the following line to your python requirements:

cdh-django-core[all] @ git+https://github.com/CentreForDigitalHumanities/django-shared-core.git@<version>

Replacing <version> with the latest DSC release tag. (e.g. v3.2.0).

This will install the entire library with all required dependencies.

See the documentation for per-app instructions on installing the specific apps in your django project.

Lean

The library can be installed with a reduced dependency set for the apps your project uses. To do this, replace the all with a comma-separated list of the apps your project uses (sans cdh.). For example:

cdh-django-core[core,files,rest] @ git+https://github.com/CentreForDigitalHumanities/django-shared-core.git@[version]

App collection

Core (cdh.core)

Base block for pure-Django projects, containing base templates, generic views, extra form/model fields and other miscellaneous code.

Requires Django >= 4.2;

Federated authentication (cdh.federated_auth)

Helper app to connect a Django application as a Service Provider to a Federated Authentication realm. Currently only supports SAML.

Requires Django >= 4.2;

Files (cdh.files)

An alternative to Django's built-in FileField, that manages a file's lifecycle, allows for copy-on-write sharing of files, is object-storage ready, allows arbitrary metadata to be added and most-importantly makes sysadmins happy.

Soft requirement on cdh.core, can work standalone if needed. Required Django >= 4.2.

Integration platform (cdh.integration_platform)

Ready-to-use API clients for the UU's integration platform.

Requires cdh.rest; Requires Django >= 4.2.

Mail (cdh.mail)

Helper app to send emails with Django, both in-code and as user defined/written. Supports generating plain/html emails from templates without having to define separate templates for each.

Replaces cdh.core.mail.

Requires Django >= 4.2. Soft-requires cdh.core, when using the mail-editor widget.

Rest (cdh.rest)

Contains code for both server and client roles. Server code contains some mixins, JWT authentication support and other helpfull snippits.

Client code contains a full Django-ORM inspired REST client, for easy (de)serialization and transactions with REST APIs.

Requires Django >= 4.2;

System messages (cdh.systemmessages)

Simple app to quickly add a 'system message' system to your app, useful for temporary announcements.

Requires Django >= 4.2;

Vue (cdh.vue)

DEPRECATED

Helper app to (more) easily integrate small(-ish) Vue 2 components in your Django templates.

Requires Django >= 4.2;

Vue 3 (cdh.vue3)

Helper app to (more) easily integrate small(-ish) Vue 3 components in your Django templates.

Requires Django >= 4.2;

Included libraries

These libraries have been completely integrated into this codebase

django-encrypted-model-fields

Modified for better Django 2.2 support and some additional tweaks.

Source: https://gitlab.com/lansharkconsulting/django/django-encrypted-model-fields/

Licenced under the MIT licence, see cdh/core/fields/LICENSE.

django-js-urls

Modified to better suit our usage

Source: https://github.com/impak-finance/django-js-urls

Licenced under the MIT license, see cdh/core/js_urls/LICENSE

Select2 Bootstrap 5 Theme

Modified to always apply, minor fixes and better SCSS integration

Source: https://github.com/apalfrey/select2-bootstrap-5-theme

Licenced under the MIT license, see scss/select2-bootstrap/LICENSE

Partly included libraries

These libraries are partly integrated into this codebase. This means that we still use the original package as a dependency, but parts of it have been copied and modified into this codebase as overrides.

vbuild

Partly overriden for integration into a larger Django infrastructure (the cdh.vue app)

Source: https://github.com/manatlan/vbuild

Licensed under the MIT license, see https://github.com/manatlan/vbuild/blob/master/LICENSE