Metadata-Version: 2.1
Name: fairdatapoint
Version: 0.7.0
Summary: Python implementation of FAIR Data Point
Home-page: https://github.com/NLeSC/fairdatapoint
Author: Rajaram Kaliyaperumal, Arnold Kuzniar, Cunliang Geng, Carlos Martinez-Ortiz
Author-email: c.martinez@esciencecenter.nl
License: Apache Software License 2.0
Description: # FAIR Data Point (FDP)
        
        [![PyPI](https://img.shields.io/pypi/v/fairdatapoint)](https://pypi.org/project/fairdatapoint/)
        [![DOI](https://zenodo.org/badge/37470907.svg)](https://zenodo.org/badge/latestdoi/37470907)
        [![Research Software Directory](https://img.shields.io/badge/RSD-FAIRDataPoint-red)](https://research-software.nl/software/fairdatapoint)
        [![Build Status](https://travis-ci.org/NLeSC/fairdatapoint.svg?branch=master)](https://travis-ci.org/NLeSC/fairdatapoint)
        [![Coverage Status](https://coveralls.io/repos/github/NLeSC/fairdatapoint/badge.svg?branch=master)](https://coveralls.io/github/NLeSC/fairdatapoint?branch=master)
        
        
        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](http://www.force11.org/group/fairgroup/fairprinciples). 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](https://github.com/FAIRDataTeam/FAIRDataPoint-Spec/blob/master/spec.md)
        
        FDP has been implemented in:
        * [Python](https://github.com/NLeSC/FAIRDataPoint/)
        * [Java](https://github.com/DTL-FAIRData/FAIRDataPoint)
        
        ## Installation
        
        To install FDP, do
        
        From pypi
        ```bash
        pip install fairdatapoint
        ```
        
        Or from this repo
        ```bash
        git clone https://github.com/NLeSC/fairdatapoint.git
        cd fairdatapoint
        pip install .
        ```
        
        
        ## Running
        ```bash
        fdp-run localhost 80
        ```
        
        Then visit from your browser: http://localhost/
        
        ## Unit testing
        Run tests (including coverage) with:
        
        ```bash
        pip install .[tests]
        pytest
        ```
        
        TODO: Include a link to your project's full documentation here.
        
        
        ## Deploy with Docker
        
        Download the `docker-compose.prod.yml` from this repo, change the `HOSTNAME` in the file to a proper host.
        The default port is `80`, and you can use other port (e.g. `8080`) if port `80` is used.
        Then run the command
        ```
        docker-compose -f docker-compose.prod.yml up -d
        ```
        
        ## Deploy without Docker
        
        Before deploying FDP, it's necessary to first have a running SPARQL database.
        
        ```
        pip install fairdatapoint
        
        # fdp-run <host> <port> --db=<sparql-endpoint>
        fdp example.com 80 --db='http://dbpedia.org/sparql'
        ```
        
        ## Web API documentation
        
        FAIR Data Point (FDP) exposes the following endpoints (URL paths):
        
        | Endpoint |  GET  | POST |      DELETE     |
        |--------------|:--------------:|:-----------------:|:--------------:|
        | fdp | Output metadata triples | Remove existing triples for a specific ID, then create new triples with the request data | Not Allowed |
        | catalog/     | Output all IDs   | Remove existing triples for a specific ID, then create new triples with the request data | Remove all IDs |
        | dataset/     | Output all IDs   | Remove existing triples for a specific ID, then create new triples with the request data | Remove all IDs |
        | distribution/  | Output all IDs  | Remove existing triples for a specific ID, then create new triples with the request data | Remove all IDs |
        | catalog/\<catalogID\> | Output metadata triples | Not Allowed | Remove the specific ID |
        | dataset/\<datasetID\> | Output metadata triples | Not Allowed | Remove the specific ID |
        | distribution/\<distributionID\> | Output metadata triples | Not Allowed | Remove the specific ID |
        
        
        ### 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](CONTRIBUTING.rst).
        
        ## 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](https://github.com/audreyr/cookiecutter) and the [NLeSC/python-template](https://github.com/NLeSC/python-template).
        
        
        
Keywords: fdp,fairdatapoint
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: tests
Provides-Extra: docs
