A very small module to add Linked Data API functionality to a Python Flask installation
Project description
# 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>
* **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>
* *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>
<http://orcid.org/0000-0002-8742-7730>
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>
* **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>
* *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>
<http://orcid.org/0000-0002-8742-7730>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyldapi-1.0.0.tar.gz
(6.9 kB
view hashes)
Built Distribution
Close
Hashes for pyldapi-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c5366b6a7a4f3bd78d5edbdf0a5f06e7d557cce86d0bd6b912c9ca988381338 |
|
MD5 | 95d43ca4bc2d6825d2ba44148c8591c9 |
|
BLAKE2b-256 | 3debd34cd0602caad0e39fc3cab2df1759107368d37182318eced17edc4fd48e |