Python implementation of FAIR Data Point
FAIR Data Point (FDP)
Python implementation of FAIR Data Point.
FDP is a RESTful web service that enables data owners to describe and to expose their datasets (metadata) as well as data users to discover more information about available datasets according to the FAIR Data Guiding Principles. In particular, FDP addresses the findability or discoverability of data by providing machine-readable descriptions (metadata) at four hierarchical levels:
FDP software specification can be found here
FDP has been implemented in:
To install FDP, do
pip install fairdatapoint
Or from this repo
git clone https://github.com/NLeSC/fairdatapoint.git cd fairdatapoint pip install .
fdp-run localhost 80
Run tests (including coverage) with:
pip install .[tests] pytest
TODO: Include a link to your project's full documentation here.
Deploy with Docker
Deploy without Docker
Before deploying FDP, it's necessary to first have a running SPARQL database which can be used to store metadata.
pip install fairdatapoint # fdp-run <host> <port> --db=<sparql-endpoint> # Let's assume your <host> is 'example.com' and <sparql-endpoint> is 'http://example.com/sparql', then fdp-run example.com 80 --db='http://example.com/sparql'
Web API documentation
FAIR Data Point (FDP) exposes the following endpoints (URL paths):
|fdp||Output fdp metadata||Create new fdp metadata||Update fdp metadata||Not Allowed|
|catalog||Output all catalog IDs||Create new catalog metadata||Not Allowed||Not Allowed|
|dataset||Output all dataset IDs||Create new dataset metadata||Not Allowed||Not Allowed|
|distribution||Output all distribution IDs||Create new distribution metadata||Not Allowed||Not Allowed|
|catalog/<catalogID>||Output <catalogID> metadata||Not Allowed||Update <catalogID> metadata||Remove <catalogID> metadata|
|dataset/<datasetID>||Output <datasetID> metadata||Not Allowed||Update <datasetID> metadata||Remove <datasetID> metadata|
|distribution/<distributionID>||Output <distributionID> metadata||Not Allowed||Update <distributionID> metadata||Remove <distributionID> metadata|
Access endpoints to request metadata programmatically
curl -iH 'Accept: text/turtle' [BASE URL]/fdp
curl -iH 'Accept: text/turtle' [BASE URL]/catalog/catalog01
curl -iH 'Accept: text/turtle' [BASE URL]/dataset/dataset01
curl -iH 'Accept: text/turtle' [BASE URL]/distribution/dist01
FDP supports the following RDF serializations (MIME-types):
If you want to contribute to the development of FAIR Data Point, have a look at the contribution guidelines.
Copyright (c) 2019,
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for fairdatapoint-0.7.2-py3-none-any.whl