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