Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/RDFLib/pyLODE

An OWL ontology documentation tool using Python and templating, based on LODE
https://github.com/RDFLib/pyLODE

documentation jinja2 lode owl python rdf templates

Last synced: 3 months ago
JSON representation

An OWL ontology documentation tool using Python and templating, based on LODE

Host: GitHub
URL: https://github.com/RDFLib/pyLODE
Owner: RDFLib
License: bsd-3-clause
Created: 2019-05-10T12:00:28.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-02-19T02:05:41.000Z (4 months ago)
Last Synced: 2024-03-10T04:58:45.636Z (3 months ago)
Topics: documentation, jinja2, lode, owl, python, rdf, templates
Language: Python
Homepage:
Size: 88.7 MB
Stars: 153
Watchers: 19
Forks: 65
Open Issues: 88
Metadata Files:
- Readme: README.rst
- License: LICENSE

Lists

awesome-semantic-tools - PyLode - An OWL ontology documentation tool using Python and templating, based on LODE (Uncategorized / Uncategorized)
awesome-ontology - pyLODE - Python ontology documentation generator inspired by LODE. (Ontology Utilities)
awesome-ccamel - RDFLib/pyLODE - An OWL ontology documentation tool using Python and templating, based on LODE (Python)

README

.. image:: https://rawcdn.githack.com/RDFLib/pyLODE/b1ff1b1e19262cdc21ee28c7362b1690ca18e30b/img/pyLODE-250.png

.. image:: https://badge.fury.io/py/pyLODE.svg
:target: https://badge.fury.io/py/pyLODE

pyLODE
******
An OWL ontology documentation tool using Python, based on LODE.

In addition to making web page, human-readable forms of ontologies, pyLODE encourages ontology annotation *best
practice* by only producing good results for well documented inputs! pyLODE defines what it considers 'well documented'
in sections below, e.g. `What pyLODE understands`_.

**New mode**: In v3.1.0, pyLODE now has a new mode called ``supermodel``, in addition to the existing ``ontpub`` mode. This new mode allows for documenting **profiles and modules** of multi-part models. See `supermodel.md `_ for more information.

----

**A note on the v 3.x change**

This is pyLODE version 3.0.1 and it's vastly different from pyLODE 2.x. It doesn't yet handle all the various "profiles" that pyLODE 2.13.2 does, such as SKOS 'vocabularies' & Profiles Vocabulary 'profiles', it only handles OWL 'ontologies', nor all the special data types, such as JSON literals, BUT, it generates HTML in a much more straightforward manner and the code is both more efficient and much more maintainable, which is why it's been made.

v 3.x will eventually catch up to all of v 2.13.2's features.

To access v 2.13.2 of pyLODE, either `download it from PyPI `_ , `check it out from GitHub `_ or access it via the `online service `_ .

----

Contents
========
1. `Quick Intro`_
2. Use_
3. `What pyLODE understands`_
4. Examples_
5. Installation_
6. Testing_
7. `Differences from LODE`_
8. `Releases`_
9. License_
10. Citation_
11. Collaboration_
12. Contacts_

Quick Intro
===========
The Live OWL Documentation Environment tool
(`LODE `__) is a well-known (in
Semantic Web circles) Java & XSLT-based tool used to generate
human-readable HTML documents for OWL and RDF ontologies. That tool is
now a bit dated (old-style HTML, use of older technologies like XSLT)
and its (`online version `__) is not always
online.

This tool is a complete re-implementation of LODE's functionality using
Python and Python's RDF manipulation module,
`rdflib `__. An ontology to be
documented is parsed and inspected using rdflib and HTML is generated
directly, using Python's `dominate `__
package.

Use
===

The tool can be used in multiple ways:

- BASH command line script
- pyLODE.sh in bin/
- Windows EXE
- pyLODE.exe in bin/
- Mac executable
- pyLODE in bin/
- Python Script
- cli.py or module
- as-a-service locally
- via the popular `Falcon framework `__.
- see server.py in the main folder
- as-a-service online
- hosted at https://pylode.surroundaustralia.com

Command line arguments
----------------------

The BASH, Windows EXE and Python Script methods all use the same command line
arguments:

usage: cli.py [-h] [-v] [-o OUTPUTFILE] [-c {true,false}] input

positional arguments:
input Input file location or URL

optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-o OUTPUTFILE,
--outputfile OUTPUTFILE
A name you wish to assign to the output file. Will be
postfixed with .html if not already added. If no
output file is given, output will be printed to screen
-c {true,false},
--css {true,false}
Whether (true) or not (false) to include CSS within an
output HTML file.

Basic Use
^^^^^^^^^

* as a Python script
* executed in this directory

python pylode examples/ontpub/minimal.ttl -o minimal.html

This will produce the file ``minimal.html`` in this directory which should
match exactly the file ``examples/minimal.html``.

* as a docker container

build the docker image
::

docker build -t pylode:latest .

copy the example directory, mount it to the container and run cli.py in the container
::

docker run --mount 'type=bind,src=,target=/app/pylode/data' pylode:latest python3.10 pylode/cli.py data/ -o data/

Note: must be absolute

Module Use
^^^^^^^^^^

from pylode import OntDoc

# initialise
od = OntDoc(ontology="some-ontology-file.ttl")

# produce HTML
html = od.make_html()

# or save HTML to a file
od.make_html(destination="some-resulting-html-file.html")

This will read from ``some-ontology-file.ttl`` to produce the file ``some-resulting-html-file.html`` in this directory.

Examples
========

The `examples/ directory `_
contains multiple pairs of RDF & HTML files generated from them using this
version of pyLODE.

You can also see rendered versions of these example files online too:

* `minimal.html `_
* `agift.html `_
* `alternates.html `_
* `asgs.html `_

What pyLODE understands
=======================

pyLODE knows about definitional ontologies (``owl:Ontology``) and the major
elements usually found in them, such as classes (``owl:Class`` or ``rdf:Class)
and properties (``rdf:Property`` & ``owl:ObjectProperty`` etc.).

To see what properties for ontology, class and RDF property documentation
pyLODE currently supports, just look in the ``rdf_elements.py`` file. All
elements' properties supported are given in property lists there.

pyLODES won't just translate everything that you can describe in RDF into
HTML! This is a conscious design choice to ensure that a certain conventional
style of documented ontology is produced. However, support for new
properties and ontology patterns can be made - just create an Issue on
`this project's Issue tracker `__.

While it *does* know about instance data, such as Named Individuals, it's
not really designed to document large ontologies containing class instances.

Notes on Agents
---------------
pyLODE can understand both simple and complex Agent objects. You can use
simple string properties like ``dc:contributor "Nicholas J. Car"`` too if
you really must but better would be to take advantage of real Linked Data
representation, e.g. complex Agent objects with web addresses, emails,
affiliations, ORCIDs and so on, e.g.:

dct:creator [
sdo:name "Nicholas J. Car" ;
sdo:identifier ;
sdo:affiliation [
sdo:name "SURROUND Australia Pty Ldt." ;
sdo:url "https://surroundaustralia.com"^^xsd:anyURI ;
] ;
] ;

See all the properties in ``rdf_elements.py:AGENT_PROPS`` for a list of
all the Agent properties pyLODE can handle.

Installation
============

pyLODE is `on PyPI `_, so you can install
it using `pip `_ as normal:

pip install pylode

Testing
=======

It's best to disable warnings to hide pointless warnings from the RDFLib library.

::
~$ python -m pytest tests --disable-warnings

Differences from LODE
=====================
- command line access

- you can use this on your own desktop so you don't need me to
maintain a live service for use

- use of modern simple HTML

- no JavaScript: pyLODE generates static HTML pages

- catering for a wider range of ontology options such as:

- schema.org ``domainIncludes`` & ``rangeIncludes`` for properties

- better Agent representation

- see the `Notes on Agents`_ section above

- smarter CURIES

- pyLODE caches and looks up well-known prefixes to make more/better
CURIES
- it tries to be smart with CURIE presentation by CURIE-ising all
URIs it finds, rather than printing them

- reference ontologies property labels

- pyLODE caches ~ 10 well-known ontologies (RDFS, SKOS etc), properties from which people often use for their ontology documentation. Where these properties are used, the background ontology's labels are use

- **active development**

- pyLODE has been under active development since mid-2019 and is
still very much actively developed - it's not just staying still
- it will be improved in foreseeable to cater for more and more things
- recent ontology documentation initiatives such as the `MOD
Ontology `__ will be
handled, if requested

Releases
========
pyLODE is under continual and constant development. The current developers have a roadmap for enhancements in mind,
which is given here, however, since this is an open source project, new developers may join the pyLODE dev community
and change/add development priorities.

Current Release
---------------

The current release, as of April, 2023, is **3.0.5**.

Release Schedule
----------------

.. csv-table:: **pyLODE Release Schedule**
:header: "Version", "Date", "Description"
:widths: 15, 10, 30

**3.1.1** **19 February 2024**, "Fix release"
**3.1.0**, **19 February 2024**, "Add supermodel mode - supports documenting profiles and modules"
**3.0.5**, **27 April 2023**, "Minor patching"
3.0.4, 24 May 2022, "Use of Poetry"
3.0.2, 24 May 2022, "Support for preformatted skos:example literals"
3.0.1, 6 Jan 2022, "Direct HTML generation using dominate; easier to maintain and extend"
2.13.2, 21 December 2021, "Updated RDFlib to 6.1.1, improved test to properly use pytest"
2.10.0, 24 May 2021, "Update Windows EXE build process, simplified versioning"
2.9.1, 28 Apr 2021, "Support for ASCIIDOC format (OntDoc profile only)"
2.8.11, 28 Apr 2021, "Further changes for PyPI only"
2.8.10, 27 Apr 2021, "Further changes for PyPI only"
2.8.9, 27 Apr 2021, "PyPI enhancements only"
2.8.8, 27 Apr 2021, "Several small bugs fixed, auto-generation of version no. from Git tag"
2.8.6, 23 Feb 2021, "Fixing char encoding issues, updated examples, new test files style - per issue"
2.8.5, 5 Jan 2021, "Small enhancements to the Falcon server deployment option"
2.8.3, 3 July 2020, "Packaging bugfixes only"
2.7, 1 July 2020, "Much refactoring for new profile creation ease"
2.6, June 2020, "Supports PROF profiles as well as taxonomies & ontologies"
2.4, 27 May 2020, "Small improvements over 2.0"
2.0, 18 Apr 2020, "Includes multiple profiles - OWP & vocpub"
1.0, 15 Dec 2019, "Initial working release"

License
=======
This code is licensed using the BSD 3-Clause licence. See the `LICENSE
file `_ for the deed. Note *Citation* below though for
attribution.

Citation
========
If you use pyLODE, please leave the pyLODE logo with a hyperlink back
here in the top left of published HTML pages.

Collaboration
=============
The maintainers welcome any collaboration.

If you have suggestions, please email the contacts below or leave Issues
in this repository's `Issue tracker `_.

But the very best thing you could do is create a Pull Request for us to
action!