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->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.
Metadata
Release files for fairdatapoint 0.7.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| fairdatapoint-0.7.2.tar.gz | 23.6 kB | Without provenance | Details for fairdatapoint-0.7.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fairdatapoint-0.7.2-py3-none-any.whl | Python 3 | none | any | Details for fairdatapoint-0.7.2-py3-none-any.whl |
Total release size: 43.0 kB
Release files / fairdatapoint-0.7.2.tar.gz
| Download URL | fairdatapoint-0.7.2.tar.gz |
|---|---|
| Size | 23.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
53a2f9242b7bd3666e305248d6e2d6b5032f31e02aa86c22b9c4dbccd3a875c8
|
|
BLAKE2b-256 checksum How to use checksums |
0d51692eda418d2e429f581eb3eaef69d9c26c7acc60465107777cea52107567
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / fairdatapoint-0.7.2-py3-none-any.whl
| Download URL | fairdatapoint-0.7.2-py3-none-any.whl |
|---|---|
| Size | 19.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
331c37c0c1943591e56c36c99ba892c54bd1bbba813e935cca5717f9a9925c55
|
|
BLAKE2b-256 checksum How to use checksums |
1077c33572999fe8f9771183f1e3d15506ad94d6d3e7dc14a099d9bd4598438f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Security for fairdatapoint 0.7.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.