Installation and basic concepts of the SODAR Core framework and its apps are detailed in this document.
django-sodar-core package can be installed into your Django project
from PyPI as follows. It is strongly recommended to specify a version tag, as
the package is under active development and breaking changes are expected.
pip install django-sodar-core==0.13.4
Please note that the django-sodar-core package only installs Django apps, which you need to include in a Django web site project. For instructions for integrating SODAR Core into an existing Django site or setting up a new site, see the projectroles app documentation.
SODAR Core Apps
The following Django apps will be installed when installing the
projectroles: Base app for project access management and dynamic app content management. All other apps require the integration of projectroles.
adminalerts: Site app for displaying site-wide messages to all users.
appalerts: Site app and backend for raising alerts to users from apps.
bgjobs: Project app for managing background jobs.
siteinfo: Site app for displaying site information and statistics for administrators.
sodarcache: Generic caching and aggregation of data referring to external services.
timeline: Project app for logging and viewing project-related activity.
tokens: Token management for API access.
userprofile: Site app for viewing user profiles.
Major requirements for integrating projectroles and other SODAR Core apps into
your Django site are listed below. For a complete requirement list, see the
utility directories in the repository.
Ubuntu (20.04 Focal recommended and supported) / CentOS 7
System library requirements (see the
utilitydirectory and/or your own Django project)
Python >=3.8 (NOTE: Python 3.7 no longer supported in SODAR Core v0.10.8+)
PostgreSQL >=11 and psycopg2-binary
Shepherd and Tether
For more details on installation and requirements for local development, see Development Installation.
To proceed with using the SODAR Core framework in your Django site, you must
first install and integrate the
projectroles app. See the
projectroles app documentation for instructions.
Once projectroles has been integrated into your site, you may proceed to install other apps as needed.