dsp-api

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 79)

DaSCH Service Platform API

dsp-api Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# DSP-API &mdash; DaSCH Service Platform API

[![Github](https://img.shields.io/github/v/tag/dasch-swiss/dsp-api?include_prereleases&label=Github%20tag)](https://github.com/dasch-swiss/dsp-api)
[![Docker](https://img.shields.io/docker/v/daschswiss/knora-api?label=Docker%20image)](https://hub.docker.com/r/daschswiss/knora-api)
[![CI](https://github.com/dasch-swiss/dsp-app/workflows/CI/badge.svg)](https://github.com/dasch-swiss/dsp-api/actions?query=workflow%3ACI)

[DSP](https://app.dasch.swiss/) is a server application for storing, sharing, and working with primary sources and data in the humanities.

It is developed by the [Swiss National Data and Service Center for the Humanities](https://dasch.swiss)
at the [University of Basel](https://www.unibas.ch), and is supported by the
[Swiss Academy of Humanities and Social Sciences](https://www.sagw.ch) and
the [Swiss National Science Foundation](https://snf.ch).

DSP-API is [free software](http://www.gnu.org/philosophy/free-sw.en.html),
released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

## Features

* Stores humanities data as industry-standard [RDF](http://www.w3.org/TR/2014/NOTE-rdf11-primer-20140624/) graphs, plus files for binary data such as digitized primary sources.
    * Designed to work with any standards-compliant RDF triplestore. Tested with [Jena Fuseki](https://jena.apache.org/).
* Based on [OWL](http://www.w3.org/TR/2012/REC-owl2-primer-20121211/) ontologies that express abstract, cross-disciplinary commonalities in the structure and semantics of research data.
* Offers a generic HTTP-based API, implemented in [Scala](https://www.scala-lang.org/), for querying, annotating, and linking together heterogeneous data in a unified way.
    * Handles authentication and authorization.
    * Provides automatic versioning of data.
* Uses [Sipi](https://sipi.io), a high-performance media server implemented in C++.
* Designed to be be used with [DSP-APP](https://docs.dasch.swiss/latest/DSP-APP/), a general-purpose, browser-based virtual research environment,
  as well as with custom user interfaces.

## Requirements

### For developing and testing DSP-API

Each developer machine should have the following prerequisites installed:

* Linux or macOS
* [Docker Desktop](https://www.docker.com/products/docker-desktop)
* [Homebrew](https://brew.sh) (macOS)
* [Nix](https://determinate.systems) (with flakes) and [direnv](https://direnv.net/)

The build runs on [Bazel](https://bazel.build/) inside a [Nix](https://nixos.org/) dev shell defined
in `flake.nix`. The dev shell puts `bazel` (a bazelisk wrapper pinned via `.bazelversion`), a JDK
[Temurin 25](https://adoptium.net/temurin/), [`just`](https://just.systems/man/en/), and `crane` on
your `PATH`, so you do not need to install any of these separately.

#### Nix

Install Nix with the [Determinate Systems installer](https://determinate.systems) (flakes are enabled
by default):

```shell
curl -fsSL https://install.determinate.systems/nix | sh -s -- install
```

With [direnv](https://direnv.net/) installed, the dev shell loads automatically when you `cd` into the
repository — run `direnv allow` once to approve it. Without direnv, prefix commands with
`nix develop --command`, for example `nix develop --command just test-unit`.

#### EditorConfig

This repository contains a root-level `.editorconfig` to keep Markdown and YAML formatting consistent (e.g., 4-space
list indents in Markdown, 2-space YAML). Most editors support EditorConfig natively or via a plugin; consider enabling
it and format-on-save for consistent diffs.

### For building the documentation

See [docs/Readme.md](docs/Readme.md).

## Try it out

### Run DSP-API

Create a test repository, load some test data into the triplestore, and start DSP-API:

```shell
just stack-init-test
```

Open [http://localhost:4200/](http://localhost:4200) in a web browser.

On first installation, errors similar to the following can come up:

```text
error decoding 'Volumes[0]': invalid spec: :/fuseki:delegated: empty section between colons
```

To solve this, you need to deactivate Docker Compose V2. This can be done in Docker Desktop either by unchecking the "Use Docker Compose V2" flag under "Preferences > General" or by running

```text
docker-compose disable-v2
```

Shut down DSP-API:

```shell
just stack-stop
```

### Run the automated tests

Automated tests are split into different modules: fast unit tests, integration tests (service/repo/Sipi tests using [Testcontainers](https://www.testcontainers.org/)), and end-to-end HTTP API tests.

Run unit tests:

```shell
just test-unit
```

Run integration tests:

```shell
just test-it
```

Run end-to-end tests:

```shell
just test-e2e
```

Run all tests:

```shell
just test-unit test-it test-e2e
```

## Release Versioning Convention

The DSP-API release versioning follows the [Semantic Versioning](https://semver.org) convention:

> Given a version number MAJOR.MINOR.PATCH, increment the:
>
> * MAJOR version when you make incompatible API changes,
> * MINOR version when you add functionality in a backwards-compatible manner, and
> * PATCH version when you make backwards-compatible bug fixes.

Additionally, we will also increment the MAJOR version in the case when any kind of changes to existing
data would be necessary, e.g., any changes to the [knora-base ontology](https://docs.dasch.swiss/latest/DSP-API/02-dsp-ontologies/knora-base/) which are not backwards compatible.

## Issues & Contributions

If you'd like to report an issue or contribute to this project, please contact us at [support@dasch.swiss](mailto:support@dasch.swiss) so we can align it with our planning.

dsp-api

dsp-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dsp-api

dsp-api Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README