https://github.com/periodo/periodo-server

A web server for serving and accepting patches for PeriodO data
https://github.com/periodo/periodo-server

linked-data periodization periodo

Last synced: 4 days ago
JSON representation

A web server for serving and accepting patches for PeriodO data

• Host: GitHub
• URL: https://github.com/periodo/periodo-server
• Owner: periodo
• License: other
• Created: 2014-07-28T19:28:56.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T13:42:59.000Z (21 days ago)
• Last Synced: 2024-10-19T18:36:59.312Z (20 days ago)
• Topics: linked-data, periodization, periodo
• Language: Python
• Homepage: http://perio.do
• Size: 1010 KB
• Stars: 11
• Watchers: 8
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

• awesome-starred - periodo/periodo-server - A web server for serving and accepting patches for PeriodO data (others)

README

        
# PeriodO Server

A web server for serving and accepting patches for [PeriodO](http://perio.do/) data.

[![periodo server tests status](https://github.com/periodo/periodo-server/actions/workflows/run-tests.yml/badge.svg)](https://github.com/periodo/periodo-server/actions/workflows/run-tests.yml)

# Setup

Running `make` by itself will install required packages, initialize the database if it does not yet exist, and generate the RDF representing the vocabulary terms and SHACL shapes used in PeriodO data.

## Working with bags

You can create a "bag" of period URIs by sending an authenticated `PUT` request to `http://n2t.net/ark:/99152/p0bags/[UUID]`, where `[UUID]` is a [UUID (universally unique identifier)](https://en.wikipedia.org/wiki/Universally_unique_identifier) that you generate. The body of the request should be a JSON object with at least the keys `title` and `items`. The value of the `items` key must be either a list of PeriodO period identifiers, or an objects with PeriodO period identifiers as keys:

```

$ export BAG_UUID=$(uuid)

$ export AUTH_TOKEN=$(get_token_somehow)

$ curl -L -X PUT\

  -H "Authorization: Bearer $AUTH_TOKEN"

  -H "Content-Type: application/json"\

  -d '{"title": "my bag of periods", "items": ["p03377fkhrv", "p0d39r7d5km"]}'\

  "http://n2t.net/ark:/99152/p0bags/$BAG_UUID"

```

A `GET` request for a bag returns a JSON-LD representation including the full details of the bag's periods:

```

$ curl -L -X GET "http://n2t.net/ark:/99152/p0bags/$BAG_UUID" | jq .

```

```

{

  "@context": { ... },

  "@id": "p0bags/...",

  "creator": "https://orcid.org/...",

  "title": "my bag of periods",

  "items": {

    "p03377fkhrv": { ... full JSON-LD for period ... },

    "p0d39r7d5km": { ... full JSON-LD for period ... }

    }

  }

}

```

Bags are versioned. When initially created a bag has version `0`. Subsequent `PUT`s to a bag URL will increment the version. `GET` requests can be made for specific versions by appending a `version` query parameter. Bags also support [conditional requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) using [`Etag`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) headers.