Ravenports generated: 03 Jul 2018 15:33
[ravenports.git] / bucket_D6 / python-graphviz
1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
2
3 NAMEBASE=               python-graphviz
4 VERSION=                0.8.4
5 KEYWORDS=               python
6 VARIANTS=               py27 py36 py37
7 SDESC[py36]=            Simple Python interface for Graphviz (PY 36)
8 SDESC[py37]=            Simple Python interface for Graphviz (PY 37)
9 SDESC[py27]=            Simple Python interface for Graphviz (PY 27)
10 HOMEPAGE=               https://github.com/xflr6/graphviz
11 CONTACT=                Python_Automaton[python@ironwolf.systems]
12
13 DOWNLOAD_GROUPS=        main
14 SITES[main]=            PYPI/g/graphviz
15 DISTFILE[1]=            graphviz-0.8.4.zip:main
16 DF_INDEX=               1
17 SPKGS[py36]=            single
18 SPKGS[py37]=            single
19 SPKGS[py27]=            single
20
21 OPTIONS_AVAILABLE=      PY27 PY36 PY37
22 OPTIONS_STANDARD=       none
23 VOPTS[py36]=            PY27=OFF PY36=ON PY37=OFF
24 VOPTS[py37]=            PY27=OFF PY36=OFF PY37=ON
25 VOPTS[py27]=            PY27=ON PY36=OFF PY37=OFF
26
27 RUN_DEPENDS=            graphviz:primary:standard
28
29 DISTNAME=               graphviz-0.8.4
30
31 GENERATED=              yes
32
33 [PY36].USES_ON=                         python:py36
34
35 [PY37].USES_ON=                         python:py37
36
37 [PY27].USES_ON=                         python:py27
38
39 [FILE:2533:descriptions/desc.single]
40 Graphviz
41 ========
42
43 |PyPI version| |License| |Supported Python| |Format| |Docs|
44
45 |Travis| |Codecov|
46
47 This package facilitates the creation and rendering of graph descriptions
48 in
49 the DOT_ language of the Graphviz_ graph drawing software (`master repo`_)
50 from
51 Python.
52
53 Create a graph object, assemble the graph by adding nodes and edges, and
54 retrieve its DOT source code string. Save the source code to a file and
55 render
56 it with the Graphviz installation of your system.
57
58 Use the ``view`` option/method to directly inspect the resulting (PDF, PNG,
59 SVG, etc.) file with its default application. Graphs can also be rendered
60 and displayed within `Jupyter notebooks`_ (formerly known as
61 `IPython notebooks`_, example_) as well as the `Jupyter Qt Console`_.
62
63
64 Links
65 -----
66
67 - GitHub: https://github.com/xflr6/graphviz
68 - PyPI: https://pypi.org/project/graphviz/
69 - Documentation: https://graphviz.readthedocs.io
70 - Changelog: https://graphviz.readthedocs.io/en/latest/changelog.html
71 - Issue Tracker: https://github.com/xflr6/graphviz/issues
72 - Download: https://pypi.org/project/graphviz/#files
73
74
75 Installation
76 ------------
77
78 This package runs under Python 2.7, and 3.4+, use pip_ to install:
79
80 .. code:: bash
81
82     $ pip install graphviz
83
84 To render the generated DOT source code, you also need to install Graphviz
85 (`download page`_).
86
87 Make sure that the directory containing the ``dot`` executable is on your
88 systems' path.
89
90
91 Quickstart
92 ----------
93
94 Create a graph object:
95
96 .. code:: python
97
98     >>> from graphviz import Digraph
99
100     >>> dot = Digraph(comment='The Round Table')
101
102     >>> dot  #doctest: +ELLIPSIS
103     <graphviz.dot.Digraph object at 0x...>
104
105 Add nodes and edges:
106
107 .. code:: python
108
109     >>> dot.node('A', 'King Arthur')
110     >>> dot.node('B', 'Sir Bedevere the Wise')
111     >>> dot.node('L', 'Sir Lancelot the Brave')
112
113     >>> dot.edges(['AB', 'AL'])
114     >>> dot.edge('B', 'L', constraint='false')
115
116 Check the generated source code:
117
118 .. code:: python
119
120     >>> print(dot.source)  # doctest: +NORMALIZE_WHITESPACE
121     // The Round Table
122     digraph {
123         A [label="King Arthur"]
124         B [label="Sir Bedevere the Wise"]
125         L [label="Sir Lancelot the Brave"]
126         A -> B
127         A -> L
128         B -> L [constraint=false]
129     }
130
131 Save and render the source code, optionally view the result:
132
133 .. code:: python
134
135     >>> dot.render('test-output/round-table.gv', view=True)  # doctest:
136 +SKIP
137     'test-output/round-table.gv.pdf'
138
139 .. image::
140 https://raw.github.com/xflr6/graphviz/master/docs/round-table.png
141     :align: center
142
143
144 See also
145
146
147 [FILE:97:distinfo]
148 4958a19cbd8461757a08db308a4a15c3d586660417e1e364f0107d2fe481689f       166273 graphviz-0.8.4.zip
149