README.md 1.48 KB
Newer Older
lambdamusic's avatar
lambdamusic committed
1
# Ontospy
lambdamusic's avatar
lambdamusic committed
2

lambdamusic's avatar
lambdamusic committed
3
Python library and command-line interface for inspecting and visualizing RDF models.
lambdamusic's avatar
lambdamusic committed
4

lambdamusic's avatar
lambdamusic committed
5 6
#### Links

lambdamusic's avatar
lambdamusic committed
7 8 9
-   [Pypi](https://pypi.org/project/ontospy/)
-   [Github](https://github.com/lambdamusic/ontospy)
-   [Docs](http://lambdamusic.github.io/Ontospy/)
lambdamusic's avatar
lambdamusic committed
10

lambdamusic's avatar
lambdamusic committed
11
# Description
lambdamusic's avatar
lambdamusic committed
12

lambdamusic's avatar
lambdamusic committed
13
Ontospy is a lightweight Python library and command line tool for inspecting and visualizing vocabularies encoded using W3C Semantic Web standards, that is, RDF or any of its dialects (RDFS, OWL, SKOS).
14

lambdamusic's avatar
lambdamusic committed
15
The basic workflow is simple: load a graph by instantiating the `Ontospy` class with a file containing RDFS, OWL or SKOS definitions. You get back a object that lets you interrogate the ontology. That's all!
lambdamusic's avatar
lambdamusic committed
16

lambdamusic's avatar
lambdamusic committed
17
The same functionalities are accessible also via a command line application (`ontospy`). This is an interactive environment (like a repl) that allows to load ontologies from a local repository, interrogate them and cache them so that they can be quickly reloaded for inspection later on.
lambdamusic-work's avatar
lambdamusic-work committed
18

lambdamusic's avatar
lambdamusic committed
19 20 21 22 23 24 25 26
## Generating ontology documentation

Ontospy can be used to generate HTML documentation for an ontology pretty easily.

This functionality relies on a module called _ontodocs_, which used to be maintained as a separate library but is now distributed with ontospy as an add-on: `pip install ontospy[HTML]`.

For some examples of the kind of documentation that can be generated out-of-the-box, [take a look at this page](http://www.michelepasin.org/support/ontospy-examples/index.html).

lambdamusic's avatar
lambdamusic committed
27
## More info
lambdamusic-work's avatar
lambdamusic-work committed
28

lambdamusic's avatar
lambdamusic committed
29
http://lambdamusic.github.io/Ontospy/