Metadata-Version: 1.1
Name: properties-inheritance-graph
Version: 1.0.0
Summary: Make graphs of HasProperties class networks
Home-page: https://github.com/seequent/properties-inheritance-graph
Author: Seequent
Author-email: franklin.koch@seequent.com
License: UNKNOWN
Description: properties-inheritance-graph
        ----------------------------
        
        .. image:: https://img.shields.io/pypi/v/properties-inheritance-graph.svg
            :target: https://pypi.org/project/properties-inheritance-graph
        .. image:: https://travis-ci.org/seequent/properties-inheritance-graph.svg?branch=master
            :target: https://travis-ci.org/seequent/properties-inheritance-graph
        .. image:: https://codecov.io/gh/seequent/properties-inheritance-graph/branch/master/graph/badge.svg?token=yyj42i2C5k
            :target: https://codecov.io/gh/seequent/properties-inheritance-graph
        
        The purpose of this library is to quickly and easily create UML graphs
        that show inheritance structure of :code:`HasProperties` class hierarchies.
        For more information on :code:`HasProperties` classes, see
        `properties <https://github.com/seequent/properties>`_.
        
        To install
        
        .. code::
        
            pip install properties_inheritance_graph
        
        
        then in Python
        
        .. code:: python
        
            from properties_inheritance_graph import make_graph
            import omf  # or any other library built on properties
        
            graph, registry = make_graph(
                registry=omf.PointSetElement._REGISTRY,
                expand_props=True,
                only_new_props=True,
                abstract_regex='^.*Model$',
            )
        
        In the above example, the properties-based `OMF <https://github.com/gmggroup/omf>`_
        library is used for demonstration.
        
        To render these graphs to file or in a Jupyter notebook, you may use
        `nxpd <https://github.com/chebee7i/nxpd>`_. `Graphviz <https://graphviz.gitlab.io/>`_
        must also be installed.
        
        .. code:: python
        
            import nxpd
            nxpd.draw(graph, filename='inheritance_graph.png')
        
        .. image:: https://raw.githubusercontent.com/seequent/properties-inheritance-graph/master/docs/inheritance_graph.png
        
Keywords: networkx,properties,graph
Platform: Windows
Platform: Linux
Platform: Solaris
Platform: Mac OS-X
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Natural Language :: English
