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
[](https://badge.fury.io/py/pyldapi)
## How to use
This module contains only a small Python module which is indented to be added (imported) into a [Python Flask](http://flask.pocoo.org/) installation in order to add a series of extra functions to endpoints to the ones defined by you as a Flask user (URL routes).
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
## Further Documentation
Detailed documenatation is the subject of current work (September, 2018) so please revisit this location for it soon! Also, see the implementaitons below. The first is a small project.
## Implementations
* Register of Media Types
* <https://w3id.org/mediatype/>
* Linked Data version of the Geocoded National Address File
* <http://linked.data.gov.au/dataset/gnaf>
## License
This repository is licensed under GNU General Public License (GPL) v3.0. See the [LICENSE deed](LICENSE) in this repository for details.
## Contacts
Lead:
**Nicholas Car**
*Senior Experimental Scientist*
CSIRO Land & Water
<nicholas.car@csiro.au>
<http://orcid.org/0000-0002-8742-7730>
Senior Developer:
**Ashley Sommer**
*Informatics Software Engineer*
<ashley.sommer@csiro.au>
A very small module to add Linked Data API functionality to a Python Flask installation
[](https://badge.fury.io/py/pyldapi)
## How to use
This module contains only a small Python module which is indented to be added (imported) into a [Python Flask](http://flask.pocoo.org/) installation in order to add a series of extra functions to endpoints to the ones defined by you as a Flask user (URL routes).
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
## Further Documentation
Detailed documenatation is the subject of current work (September, 2018) so please revisit this location for it soon! Also, see the implementaitons below. The first is a small project.
## Implementations
* Register of Media Types
* <https://w3id.org/mediatype/>
* Linked Data version of the Geocoded National Address File
* <http://linked.data.gov.au/dataset/gnaf>
## License
This repository is licensed under GNU General Public License (GPL) v3.0. See the [LICENSE deed](LICENSE) in this repository for details.
## Contacts
Lead:
**Nicholas Car**
*Senior Experimental Scientist*
CSIRO Land & Water
<nicholas.car@csiro.au>
<http://orcid.org/0000-0002-8742-7730>
Senior Developer:
**Ashley Sommer**
*Informatics Software Engineer*
<ashley.sommer@csiro.au>
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-2.0.12.tar.gz
(11.5 kB
view details)
Built Distribution
pyldapi-2.0.12-py3-none-any.whl
(13.2 kB
view details)
File details
Details for the file pyldapi-2.0.12.tar.gz.
File metadata
- Download URL: pyldapi-2.0.12.tar.gz
- Upload date:
- Size: 11.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 17393a6a66110b6cfc063e7d90bb18c5c0decfea2e7ceb62d32282dfecb38d45 |
|
| MD5 | 046b2c8881f034830642a9fe621ec048 |
|
| BLAKE2b-256 | 9435da1fa9ff47a40e308cf40b83906eb9f4687ce3d3c883c70b4e5574909025 |
File details
Details for the file pyldapi-2.0.12-py3-none-any.whl.
File metadata
- Download URL: pyldapi-2.0.12-py3-none-any.whl
- Upload date:
- Size: 13.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a73d899bc340dfd5e86ea2c83e61d1daf70fde255fe5733bdcaef2045cd93d83 |
|
| MD5 | 3add494751316d61a11e2405cab0f3f1 |
|
| BLAKE2b-256 | 682892208b73793c0375986c083cc4cfececec7cdfac34d56a0b13abf7f4f870 |
