SODAR Core ^^^^^^^^^^
.. |b1| image:: https://badge.fury.io/py/django-sodar-core.svg :target: https://badge.fury.io/py/django-sodar-core
.. |b2| image:: https://github.com/bihealth/sodar-core/actions/workflows/build.yml/badge.svg :target: https://github.com/bihealth/sodar-core/actions?query=workflow%3ABuild
.. |b3| image:: https://coveralls.io/repos/github/bihealth/sodar-core/badge.svg?branch=main :target: https://coveralls.io/github/bihealth/sodar-core?branch=main
.. |b4| image:: https://img.shields.io/badge/License-MIT-green.svg :target: https://opensource.org/licenses/MIT
.. |b5| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black
.. |b6| image:: https://readthedocs.org/projects/sodar-core/badge/?version=latest :target: https://sodar-core.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. |b7| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4269346.svg :target: https://doi.org/10.5281/zenodo.4269346
|b1| |b2| |b3| |b4| |b5| |b6| |b7|
SODAR Core is a framework for Django web application development.
It was conceived to facilitate the creation of scientific data management and
analysis web applications, but can be useful in other contexts as well.
In that it is similar to the CMS or ecommerce frameworks that you can find
Awesome Django List <https://github.com/wsvincent/awesome-django#content-management-systems>
__ but you will find the components/libraries provided in SODAR Core are more generic and in this reflecting the broader range of applications that we target.
SODAR Core is a framework for developing Django web applications. The following data management and analysis web applications are based on SODAR Core and have been made available as open source:
github.com/bihealth/sodar-server <https://github.com/bihealth/sodar-server>
__.NAR Web Server Issue publication (doi:10.1093/nar/gkaa241) <https://doi.org/10.1093/nar/gkaa241>
.
The source code can be found on github.com/bihealth/varfish-server <https://github.com/bihealth/varfish-server>
.
A demo is available at varfish-demo.bihealth.org <https://varfish-demo.bihealth.org/login/>
__.Bioinformatics (doi:10.1093/bioinformatics/btz850) <https://doi.org/10.1093/bioinformatics/btz850>
.
The source code can be found on github.com/bihealth/digestiflow-server <https://github.com/bihealth/digestiflow-server>
.github.com/bihealth/kiosc <https://github.com/bihealth/kiosc>
__.SODAR Core can only be used from within Django projects. The easiest way to
start out is following the For the Impatient <https://sodar-core.readthedocs.io/en/latest/for_the_impatient.html>
__
section in our documentation.
The SODAR Core repository containes reusable and non-domain-specific apps making up the base of the SODAR system. These apps can be used for any Django application which wants to make use of the following features:
This repository provides the following installable Django apps:
Also included are resources and examples for developing SODAR compatible apps.
The django-sodar-core
package can be installed into your Django project
from PyPI as follows. Note that it is strongly recommended to freeze the
dependency to a specific version, as this package is under active development
and breaking changes are possible.
.. code-block:: console
pip install django-sodar-core==1.0.2
For installing a development version you can point your dependency to a specific commit ID in GitHub. Note that these versions may not be stable.
.. code-block:: console
pip install -e git+https://github.com/bihealth/sodar-core.git@xxxxxxxxxxxxx#egg=django-sodar-core
Please note that This package installs a collection of Django apps to be used in
a Django web site project. See
SODAR Core documentation <https://sodar-core.readthedocs.io/en/latest/?badge=latest>
_
for detailed documentation on use, integration and development.
The branches of the SODAR Core repository are organized as follows:
main
The latest stable release.
dev
The current development branch. Most recent features go here, but stability
is not guaranteed. Pull requests should always be based on this branch.
When including SODAR Core in your Django project, it is highly recommended to freeze your dependency to a specific release tag or commit ID. The project is under development and breaking changes may be introduced frequently.