Metadata-Version: 2.0
Name: pyldapi
Version: 1.0.7
Summary: A very small module to add Linked Data API functionality to a Python Flask installation
Home-page: https://github.com/CSIRO-enviro-informatics/pyldapi
Author: Nicholas Car
Author-email: nicholas.car@csiro.au
License: LICENSE.txt
Download-URL: https://github.com/CSIRO-enviro-informatics/pyldapi/archive/v1.0.7.tar.gz
Project-URL: Bug Reports, https://github.com/CSIRO-enviro-informatics/pyldapi/issues
Project-URL: Source, https://github.com/CSIRO-enviro-informatics/pyldapi/
Keywords: Linked Data,Semantic Web,Flask,Python,API,RDF
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: flask
Requires-Dist: requests
Requires-Dist: rdflib
Requires-Dist: rdflib-jsonld

Python Linked Data API (pyLDAPI)
================================
A very small module to add Linked Data API functionality to a Python Flask installation


How to use
----------
This module contains only a single Python file with a few static methods and classes that are indented to be added to a Flask API in order to add a series of extra functions to endpoints that the API delivers. It will also require the addition of one API endpoint - a 'Register of Registers' (see below) - if it is not already present.

An API using this module will get:

* an *alternates view* for each *Register* and *Object* that the API delivers
    - if the API declares the appropriate *model view* s for each item
* a *Register of Registers*
    - a start-up function that auto-generated a Register of Registers is run when the API is launched
* a basic, over-writeable, template for Registers' HTML & RDF



Definitions
-----------
* **alternates view**: the *model view* that lists all other views. This API uses the definition of *alternates view* presented at `https://promsns.org/def/alt <https://promsns.org/def/alt>`_
* **Linked Data principles**: principles of making things available over the Internet in both human and machine readable forms. codified by the World Wide Web Consortium. See `https://www.w3.org/standards/semanticweb/data <https://www.w3.org/standards/semanticweb/data>`_
* *model view*: a set of properties of a Linked Data object codified according to a standard or profile of a standard
* **Object**: any individual thing delivered according to *Linked Data principles*
* **Register**: a simple listing of URIs of objects, delivered according to *Linked Data principles*
* **Register of Registers**: a a *register* that lists all other *registers* that an API provides


License
-------
This repository is licensed under GNU General Public License (GPL) v3.0. See the [LICENSE deed](LICENSE) in this repository for details.


Contacts
--------
| Developer and Point of Contact:
| **Nicholas Car**
| *Senior Experimental Scientist*
| CSIRO Land & Water
| `nicholas.car@csiro.au <nicholas.car@csiro.au>`_
| `http://orcid.org/0000-0002-8742-7730 <http://orcid.org/0000-0002-8742-7730>`_


