File: PKG-INFO

package info (click to toggle)
python-graphviz 0.14.2-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 712 kB
  • sloc: python: 1,821; makefile: 13
file content (189 lines) | stat: -rw-r--r-- 7,649 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
Metadata-Version: 2.1
Name: graphviz
Version: 0.14.2
Summary: Simple Python interface for Graphviz
Home-page: https://github.com/xflr6/graphviz
Author: Sebastian Bank
Author-email: sebastian.bank@uni-leipzig.de
License: MIT
Project-URL: Documentation, https://graphviz.readthedocs.io
Project-URL: Changelog, https://graphviz.readthedocs.io/en/latest/changelog.html
Project-URL: Issue Tracker, https://github.com/xflr6/graphviz/issues
Description: Graphviz
        ========
        
        |PyPI version| |License| |Supported Python| |Format|
        
        |Travis| |Codecov| |Readthedocs-stable| |Readthedocs-latest|
        
        This package facilitates the creation and rendering of graph descriptions in
        the DOT_ language of the Graphviz_ graph drawing software (`master repo`_) from
        Python.
        
        Create a graph object, assemble the graph by adding nodes and edges, and
        retrieve its DOT source code string. Save the source code to a file and render
        it with the Graphviz installation of your system.
        
        Use the ``view`` option/method to directly inspect the resulting (PDF, PNG,
        SVG, etc.) file with its default application. Graphs can also be rendered
        and displayed within `Jupyter notebooks`_ (formerly known as
        `IPython notebooks`_, example_) as well as the `Jupyter Qt Console`_.
        
        
        Links
        -----
        
        - GitHub: https://github.com/xflr6/graphviz
        - PyPI: https://pypi.org/project/graphviz/
        - Documentation: https://graphviz.readthedocs.io
        - Changelog: https://graphviz.readthedocs.io/en/latest/changelog.html
        - Issue Tracker: https://github.com/xflr6/graphviz/issues
        - Download: https://pypi.org/project/graphviz/#files
        
        
        Installation
        ------------
        
        This package runs under Python 2.7, and 3.5+, use pip_ to install:
        
        .. code:: bash
        
            $ pip install graphviz
        
        To render the generated DOT source code, you also need to install Graphviz
        (`download page`_).
        
        Make sure that the directory containing the ``dot`` executable is on your
        systems' path.
        
        
        Quickstart
        ----------
        
        Create a graph object:
        
        .. code:: python
        
            >>> from graphviz import Digraph
        
            >>> dot = Digraph(comment='The Round Table')
        
            >>> dot  #doctest: +ELLIPSIS
            <graphviz.dot.Digraph object at 0x...>
        
        Add nodes and edges:
        
        .. code:: python
        
            >>> dot.node('A', 'King Arthur')
            >>> dot.node('B', 'Sir Bedevere the Wise')
            >>> dot.node('L', 'Sir Lancelot the Brave')
        
            >>> dot.edges(['AB', 'AL'])
            >>> dot.edge('B', 'L', constraint='false')
        
        Check the generated source code:
        
        .. code:: python
        
            >>> print(dot.source)  # doctest: +NORMALIZE_WHITESPACE
            // The Round Table
            digraph {
                A [label="King Arthur"]
                B [label="Sir Bedevere the Wise"]
                L [label="Sir Lancelot the Brave"]
                A -> B
                A -> L
                B -> L [constraint=false]
            }
        
        Save and render the source code, optionally view the result:
        
        .. code:: python
        
            >>> dot.render('test-output/round-table.gv', view=True)  # doctest: +SKIP
            'test-output/round-table.gv.pdf'
        
        .. image:: https://raw.github.com/xflr6/graphviz/master/docs/round-table.png
            :align: center
        
        
        See also
        --------
        
        - pygraphviz_ |--| full-blown interface wrapping the Graphviz C library with SWIG
        - graphviz-python_ |--| official Python bindings (documentation_)
        - pydot_ |--| stable pure-Python approach, requires pyparsing
        
        
        License
        -------
        
        This package is distributed under the `MIT license`_.
        
        
        .. _pip: https://pip.readthedocs.io
        .. _Graphviz:  https://www.graphviz.org
        .. _master repo: https://gitlab.com/graphviz/graphviz/
        .. _download page: https://www.graphviz.org/download/
        .. _DOT: https://www.graphviz.org/doc/info/lang.html
        .. _Jupyter notebooks: https://jupyter.org
        .. _IPython notebooks: https://ipython.org/notebook.html
        .. _example: https://nbviewer.jupyter.org/github/xflr6/graphviz/blob/master/examples/notebook.ipynb
        .. _Jupyter Qt Console: https://qtconsole.readthedocs.io
        
        .. _pygraphviz: https://pypi.org/project/pygraphviz/
        .. _graphviz-python: https://pypi.org/project/graphviz-python/
        .. _documentation: https://www.graphviz.org/pdf/gv.3python.pdf
        .. _pydot: https://pypi.org/project/pydot/
        
        .. _MIT license: https://opensource.org/licenses/MIT
        
        
        .. |--| unicode:: U+2013
        
        
        .. |PyPI version| image:: https://img.shields.io/pypi/v/graphviz.svg
            :target: https://pypi.org/project/graphviz/
            :alt: Latest PyPI Version
        .. |License| image:: https://img.shields.io/pypi/l/graphviz.svg
            :target: https://pypi.org/project/graphviz/
            :alt: License
        .. |Supported Python| image:: https://img.shields.io/pypi/pyversions/graphviz.svg
            :target: https://pypi.org/project/graphviz/
            :alt: Supported Python Versions
        .. |Format| image:: https://img.shields.io/pypi/format/graphviz.svg
            :target: https://pypi.org/project/graphviz/
            :alt: Format
        
        .. |Travis| image:: https://travis-ci.org/xflr6/graphviz.svg?branch=master
            :target: https://travis-ci.org/xflr6/graphviz
            :alt: Travis
        .. |Codecov| image:: https://codecov.io/gh/xflr6/graphviz/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/xflr6/graphviz
            :alt: Codecov
        .. |Readthedocs-stable| image:: https://readthedocs.org/projects/graphviz/badge/?version=stable
            :target: https://graphviz.readthedocs.io/en/stable/?badge=stable
            :alt: Readthedocs stable
        .. |Readthedocs-latest| image:: https://readthedocs.org/projects/graphviz/badge/?version=latest
            :target: https://graphviz.readthedocs.io/en/latest/?badge=latest
            :alt: Readthedocs latest
Keywords: graph visualization dot render
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*
Provides-Extra: dev
Provides-Extra: test
Provides-Extra: docs