Metadata-Version: 2.1
Name: pyldapi
Version: 2.1.2.post5
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/v2.1.2.post5.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 :: 4 - Beta
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: flask
Requires-Dist: flask-paginate
Requires-Dist: rdflib
Requires-Dist: rdflib-jsonld

Welcome to pyLDAPI
==================

The Python Linked Data API (pyLDAPI) is:

*A very small module to add Linked Data API functionality to a Python Flask installation*.

|PyPI version|

.. |PyPI version| image:: https://badge.fury.io/py/pyldapi.svg
    :target: https://badge.fury.io/py/pyldapi

What is it?
-----------

This module contains only a small Python module which is intended to be added (imported) into a `Python Flask`_ installation in order to add a series of extra functions to endpoints to the ones defined by you as a Flask user (URL routes).

.. _Python Flask: http://flask.pocoo.org/

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 views* for each item
* a *Register of Registers*
   * a start-up function that auto-generates 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: https://promsns.org/def/alt

Linked Data Principles
~~~~~~~~~~~~~~~~~~~~~~
The 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: 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 *register* that lists all other registers which this API provides.



pyLDAPI in action
-----------------

* Register of Media Types
   * `https://w3id.org/mediatype/`_

.. _https://w3id.org/mediatype/: https://w3id.org/mediatype/

* Linked Data version of the Geocoded National Address File
   * `http://linked.data.gov.au/dataset/gnaf`_

.. _http://linked.data.gov.au/dataset/gnaf: http://linked.data.gov.au/dataset/gnaf



Documentation
-------------

Detailed documentation can be found at `https://pyldapi.readthedocs.io/`_

.. _https://pyldapi.readthedocs.io/: https://pyldapi.readthedocs.io/



Licence
-------

This is licensed under GNU General Public License (GPL) v3.0. See the `LICENSE deed`_ for more details.

.. _LICENSE deed: https://raw.githubusercontent.com/RDFLib/pyLDAPI/master/LICENSE



Contact
-------

Nicholas Car (lead)
~~~~~~~~~~~~~~~~~~~
| *Senior Experimental Scientist*
| `CSIRO Land and Water`_
| `nicholas.car@csiro.au`_
| `http://orcid.org/0000-0002-8742-7730`_

.. _nicholas.car@csiro.au: nicholas.car@csiro.au
.. _http://orcid.org/0000-0002-8742-7730: http://orcid.org/0000-0002-8742-7730

Ashley Sommer (senior developer)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| *Informatics Software Engineer*
| `CSIRO Land and Water`_
| `ashley.sommer@csiro.au`_

.. _ashley.sommer@csiro.au: ashley.sommer@csiro.au

.. _CSIRO Land and Water: https://www.csiro.au/en/Research/LWF


Related work
------------

`pyLDAPI Client`_

* *A Simple helper library for consuming registers, indexes, and instances of classes exposed via a pyLDAPI endpoint.*

.. _pyLDAPI Client: http://pyldapi-client.readthedocs.io/


