Skip to main content

Python implementation of FAIR Data Point

Project description

FAIR Data Point (FDP)

PyPI Docker Image Version (latest by date) DOI Research Software Directory Build Status Coverage Status

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->catalogs->datasets->distributions

FDP software specification can be found here

FDP has been implemented in:

Installation

To install FDP, do

From pypi

pip install fairdatapoint

Or from this repo

git clone https://github.com/NLeSC/fairdatapoint.git
cd fairdatapoint
pip install .

Running

fdp-run localhost 80

The Swagger UI is enabled for FDP service, and you can have a try by visiting http://localhost.

Unit testing

Run tests (including coverage) with:

pip install .[tests]
pytest

TODO: Include a link to your project's full documentation here.

Deploy with Docker

Check fairdatapoint-service.

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):

Endpoint GET POST PUT DELETE
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

FDP: curl -iH 'Accept: text/turtle' [BASE URL]/fdp

Catalog: curl -iH 'Accept: text/turtle' [BASE URL]/catalog/catalog01

Dataset: curl -iH 'Accept: text/turtle' [BASE URL]/dataset/dataset01

Distribution: curl -iH 'Accept: text/turtle' [BASE URL]/distribution/dist01

FDP supports the following RDF serializations (MIME-types):

  • Turtle: text/turtle
  • N-Triples: application/n-triples
  • N3: text/n3
  • RDF/XML: application/rdf+xml
  • JSON-LD: application/ld+json

Contributing

If you want to contribute to the development of FAIR Data Point, have a look at the contribution guidelines.

License

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

http://www.apache.org/licenses/LICENSE-2.0

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.

Credits

This package was created with Cookiecutter and the NLeSC/python-template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fairdatapoint-0.7.2.tar.gz (23.6 kB view details)

Uploaded Source

Built Distribution

fairdatapoint-0.7.2-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file fairdatapoint-0.7.2.tar.gz.

File metadata

  • Download URL: fairdatapoint-0.7.2.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.3

File hashes

Hashes for fairdatapoint-0.7.2.tar.gz
Algorithm Hash digest
SHA256 53a2f9242b7bd3666e305248d6e2d6b5032f31e02aa86c22b9c4dbccd3a875c8
MD5 993515d36c6c424e8b7a6d05caf2ab89
BLAKE2b-256 0d51692eda418d2e429f581eb3eaef69d9c26c7acc60465107777cea52107567

See more details on using hashes here.

File details

Details for the file fairdatapoint-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: fairdatapoint-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.3

File hashes

Hashes for fairdatapoint-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 331c37c0c1943591e56c36c99ba892c54bd1bbba813e935cca5717f9a9925c55
MD5 12a1c997af1837bb7c067dbd4a0ee27c
BLAKE2b-256 1077c33572999fe8f9771183f1e3d15506ad94d6d3e7dc14a099d9bd4598438f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page