Metadata-Version: 2.1
Name: ontogram
Version: 0.1.0.post1
Summary: Ontogram is an OWL ontology diagram generator.
Home-page: https://github.com/edmondchuc/ontogram
Author: Edmond Chuc
Author-email: edmond.chuc@gmail.com
License: UNKNOWN
Description: # Ontogram
        
        Ontogram is an OWL ontology diagram generator.
        
        Currently it supports `owl:class`, `rdfs:subClassOf`, `owl:equivalentClass`, datatype properties and domain and range relationships. I am planning to add support for `owl:subClassOf` restrictions soon. 
        
        
        ## Example output
        
        The output of [examples/tern-org.ttl](examples/tern-org.ttl).
        
        ![generated ontology diagram](examples/tern-org.ttl.txt.png)
        
        
        ## Installation
        
        Install via PyPI for Python 3.
        
        ```
        pip3 install ontogram
        ```
        
        
        ## Usage
        
        ### Web service
        
        *Coming soon.*
        
        
        ### Command line application
        
        ```
        $ ontogram --help
        
        Usage: ontogram [OPTIONS] ONTOLOGY_FILEPATH
        
          Ontogram CLI is a tool to generate a diagram from an OWL ontology file.
        
        Options:
          --format ['turtle', 'xml', 'nt', 'n3']
                                          RDF serialization of input file. Default is
                                          turtle.
          --help                          Show this message and exit.
        ```
        
        Use Ontogram's CLI to generate diagrams of an OWL ontology.
        ```
        ontogram ontology.ttl
        ```
        
        Output will be 3 files, `ontology.ttl.txt`, `ontology.ttl.png`, `ontology.ttl.svg`.
        
        Use the --format option to specify the RDF serialization of the ontology if it is not Turtle.
        
        
        ### Python library
        
        Ontogram is a Python library and can be easily integrated with any existing Python application.
        
        ```python
        from ontogram import Ontogram
        
        # First parameter accepts a file path to the OWL ontology. 
        # Second parameter tells Ontogram what RDF format the OWL ontology is in.
        ontogram = Ontogram('ontology.ttl', format='turtle')
        
        # Generate a PNG diagram from the OWl ontology and write to disk as 'ontology.ttl.txt'.
        ontogram.png_file('ontology.ttl.txt')
        
        # Same as above, but as an SVG diagram. 
        ontogram.svg_file('ontology.ttl.svg')
        ```
        
        See the [examples](examples) directory for example outputs.
        
        
        ## Docker image for diagram generation within pyLODE
        
        A Docker image has been created to automatically embed the generated diagram into a pyLODE document. See https://github.com/edmondchuc/docker-pylode
        
        See the pyLODE output with the generated ontology diagram: https://w3id.org/tern/ontologies/org
        
        A more formal integration with pyLODE will be coming soon.
Platform: UNKNOWN
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-Python: >=3.6
Description-Content-Type: text/markdown
