Dinu Gherman avatar Dinu Gherman committed 912ea47

Initial checkin of version 0.1.0.

Comments (0)

Files changed (155)

+include MANIFEST.in
+include README.*
+include gpl-3.0.*
+include test/*.py
+include test/output/*
+Metadata-Version: 1.0
+Name: pyrels
+Version: 0.1.0
+Summary: A tool for displaying relationships between Python objects.
+Home-page: http://www.dinu-gherman.net/
+Author: Dinu Gherman
+Author-email: gherman@darwin.in-berlin.de
+License: GNU General Public Licence v3 (GPLv3)
+Download-URL: http://www.dinu-gherman.net/tmp/pyrels-0.1.0.tar.gz
+Description: A tool for displaying relationships between Python objects.
+        Currently pyrels takes Python namespaces and generates graphs
+        in the GraphViz DOT format that describe Python datastructures
+        and references from names to objects.
+Keywords: visualizing,Python,relationships,references,namespaces
+Platform: Posix
+Platform: Windows
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development
+Classifier: Topic :: Scientific/Engineering :: Visualization
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
+<title>Pyrels</title>
+<meta name="author" content="Dinu Gherman &lt;gherman&#64;darwin.in-berlin.de&gt;" />
+<meta name="date" content="2008-07-08" />
+<meta name="copyright" content="GNU Public Licence v3 (GPLv3)" />
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 5196 2007-06-03 20:25:28Z wiemann $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left {
+  clear: left }
+
+img.align-right {
+  clear: right }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font-family: serif ;
+  font-size: 100% }
+
+pre.literal-block, pre.doctest-block {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="pyrels">
+<h1 class="title">Pyrels</h1>
+<h2 class="subtitle" id="explore-and-visualize-relationships-between-python-objects">Explore and visualize relationships between Python objects.</h2>
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Author:</th>
+<td>Dinu Gherman &lt;<a class="reference external" href="mailto:gherman&#64;darwin.in-berlin.de">gherman&#64;darwin.in-berlin.de</a>&gt;</td></tr>
+<tr class="field"><th class="docinfo-name">Homepage:</th><td class="field-body"><a class="reference external" href="http://www.dinu-gherman.net/">http://www.dinu-gherman.net/</a></td>
+</tr>
+<tr><th class="docinfo-name">Version:</th>
+<td>Version 0.1.0</td></tr>
+<tr><th class="docinfo-name">Date:</th>
+<td>2008-07-08</td></tr>
+<tr><th class="docinfo-name">Copyright:</th>
+<td>GNU Public Licence v3 (GPLv3)</td></tr>
+</tbody>
+</table>
+<!-- -*- mode: rst -*- -->
+<div class="section" id="about">
+<h1>About</h1>
+<p><cite>Pyrels</cite> is a tool for exploring and visualizing relationships between
+Python objects. It does so by analysing and converting Python namespaces
+into <a class="reference external" href="http://www.graphviz.org">GraphViz</a> files in the
+<a class="reference external" href="http://www.graphviz.org/doc/info/lang.html">DOT</a> format.
+That means it displays relationships like references between Python names
+and the objects they point to, as well as containment between Python
+container objects (lists, tuples and dictionaries) and the respective
+objects they contain.</p>
+<p>At the moment <cite>pyrels</cite> is best used on Python data structures, but it is
+intended to develop it further so that it can also display other types of  relationships like inheritance, module imports, etc.</p>
+<p>One target group for <cite>pyrels</cite> are article and/or book authors who wish to
+illustrate Python data structures graphically without spending a lot of
+time for creating these illustrations manually. <cite>Pyrels</cite> can help you
+automate this process.</p>
+</div>
+<div class="section" id="installation">
+<h1>Installation</h1>
+<p>After downloading the file <tt class="docutils literal"><span class="pre">pyrels-0.2.0.tar.gz</span></tt> in your download
+directory, change into this directory and run the following command
+to unpack <cite>pyrels</cite>:</p>
+<pre class="literal-block">
+$ tar xfz pyrels-0.2.0.tar.gz
+</pre>
+<p>Then change into the newly created directory <tt class="docutils literal"><span class="pre">pyrels</span></tt> and install
+<cite>pyrels</cite> by running the following command:</p>
+<pre class="literal-block">
+$ python setup.py install
+</pre>
+<p>This will install a Python package named <cite>pyrels</cite> in the
+<tt class="docutils literal"><span class="pre">site-packages</span></tt> subfolder of your Python interpreter and a script
+tool named <tt class="docutils literal"><span class="pre">pyrels</span></tt> in your <tt class="docutils literal"><span class="pre">bin</span></tt> directory, usually in
+<tt class="docutils literal"><span class="pre">/usr/local/bin</span></tt>.</p>
+</div>
+<div class="section" id="dependencies">
+<h1>Dependencies</h1>
+<p>Some of <cite>pyrels</cite>' functions call command-line tools installed
+with GraphViz, like <tt class="docutils literal"><span class="pre">dot</span></tt>, <tt class="docutils literal"><span class="pre">neato</span></tt>, etc. In order for these to
+work you must have GraphViz installed.</p>
+</div>
+<div class="section" id="examples">
+<h1>Examples</h1>
+<p>From the system command-line you use <tt class="docutils literal"><span class="pre">pyrels</span></tt> e.g. like this:</p>
+<pre class="literal-block">
+$ pyrels &quot;L = [1, 'two', None]&quot;
+</pre>
+<p>You can use <cite>pyrels</cite> also as a Python package e.g. like this:</p>
+<pre class="literal-block">
+&gt;&gt;&gt; from pyrels.pyrels2dot import namespace2dot as ns2dot
+&gt;&gt;&gt; ns2dot(ns, outPathDot, gvtool=&quot;dot&quot;, format=&quot;pdf&quot;)
+</pre>
+</div>
+<div class="section" id="testing">
+<h1>Testing</h1>
+<p>The <cite>pyrels</cite> package comes with a Unittest test suite which
+can be run like this before (or after) building the package:</p>
+<pre class="literal-block">
+$ cd test
+$ python test_all.py
+</pre>
+<p>After the test run you'll find some PDF files in the directory
+<tt class="docutils literal"><span class="pre">test/output</span></tt>.</p>
+</div>
+<div class="section" id="bug-reports">
+<h1>Bug reports</h1>
+<p>Please report bugs and patches to Dinu Gherman
+&lt;<a class="reference external" href="mailto:gherman&#64;darwin.in-berlin.de">gherman&#64;darwin.in-berlin.de</a>&gt;. Don't forget to include information
+about operating system, Python and GraphViz versions being used.</p>
+</div>
+</div>
+</body>
+</html>
+.. -*- mode: rst -*-
+
+========
+Pyrels
+========
+
+---------------------------------------------------------------
+Explore and visualize relationships between Python objects.
+---------------------------------------------------------------
+
+:Author:  Dinu Gherman <gherman@darwin.in-berlin.de>
+:Homepage: http://www.dinu-gherman.net/
+:Version: Version 0.1.0
+:Date: 2008-07-08
+:Copyright: GNU Public Licence v3 (GPLv3)
+
+
+About
+-----
+
+`Pyrels` is a tool for exploring and visualizing relationships between 
+Python objects. It does so by analysing and converting Python namespaces 
+into `GraphViz <http://www.graphviz.org>`_ files in the 
+`DOT <http://www.graphviz.org/doc/info/lang.html>`_ format. 
+That means it displays relationships like references between Python names 
+and the objects they point to, as well as containment between Python 
+container objects (lists, tuples and dictionaries) and the respective 
+objects they contain.
+
+At the moment `pyrels` is best used on Python data structures, but it is 
+intended to develop it further so that it can also display other types of  relationships like inheritance, module imports, etc. 
+
+One target group for `pyrels` are article and/or book authors who wish to 
+illustrate Python data structures graphically without spending a lot of 
+time for creating these illustrations manually. `Pyrels` can help you 
+automate this process. 
+
+
+Installation
+------------
+
+After downloading the file ``pyrels-0.2.0.tar.gz`` in your download
+directory, change into this directory and run the following command 
+to unpack `pyrels`::
+
+  $ tar xfz pyrels-0.2.0.tar.gz
+
+Then change into the newly created directory ``pyrels`` and install 
+`pyrels` by running the following command::
+
+  $ python setup.py install
+
+This will install a Python package named `pyrels` in the 
+``site-packages`` subfolder of your Python interpreter and a script 
+tool named ``pyrels`` in your ``bin`` directory, usually in 
+``/usr/local/bin``.
+
+
+Dependencies
+------------
+
+Some of `pyrels`' functions call command-line tools installed 
+with GraphViz, like ``dot``, ``neato``, etc. In order for these to 
+work you must have GraphViz installed.
+
+
+Examples
+--------
+
+From the system command-line you use ``pyrels`` e.g. like this::
+
+  $ pyrels "L = [1, 'two', None]"
+  
+You can use `pyrels` also as a Python package e.g. like this::
+
+  >>> from pyrels.pyrels2dot import namespace2dot as ns2dot
+  >>> ns2dot(ns, outPathDot, gvtool="dot", format="pdf")
+  
+
+Testing
+-------
+
+The `pyrels` package comes with a Unittest test suite which 
+can be run like this before (or after) building the package::
+ 
+  $ cd test
+  $ python test_all.py
+
+After the test run you'll find some PDF files in the directory 
+``test/output``.
+
+
+Bug reports
+-----------
+
+Please report bugs and patches to Dinu Gherman 
+<gherman@darwin.in-berlin.de>. Don't forget to include information 
+about operating system, Python and GraphViz versions being used.
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+#!/usr/bin/env python
+# _*_ coding: UTF-8 _*_
+
+"""Visualize Python datastructures using GraphViz.
+
+Use on the command-line like this:
+    
+    pyrels "x = None; L = [None, 1, 2]"
+    pyrels --out x42.dot --format pdf --gvtool dot "x = 42"
+"""
+
+import sys
+
+from pyrels.pyrels2dot import namespace2dot
+
+
+if 0:
+    src = sys.argv[1]
+    namespace = {}
+    exec src in globals(), namespace
+    namespace2dot(namespace, path="test.dot", gvtool="dot", format="pdf")
+
+
+def main():
+    # define defaults (should all be strings)
+    optionDefaults = {"out": "test.dot", "gvtool": "dot", "format": "pdf"}
+
+    # overwrite defaults with given values on the command-line 
+    for var in optionDefaults.keys():
+        try:
+            i = sys.argv.index("--" + var)
+            exec "%s = '%s'" % (var, sys.argv[i+1])
+            del sys.argv[i:i+2]
+        except ValueError:
+            exec "%s = '%s'" % (var, optionDefaults[var])
+            
+    # validate gvtool variable  
+    gvToolNames = "dot neato twopi circo fdp".split()  
+    if gvtool not in gvToolNames:
+        raise ValueError, "gvtool must be one of: %s" % gvToolNames
+    
+    # validate format variable  
+    formatNames = "ps pdf svg svgz fig mif hpgl pcl png gif dia imap cmapx".split()  
+    if format not in formatNames:
+        raise ValueError, "format must be one of: %s" % formatNames
+    
+    # extract source code, execute it into a local namespace    
+    source = sys.argv[1]
+    namespace = {}
+    exec source in globals(), namespace
+
+    # finally call pyrels
+    namespace2dot(namespace, path=out, gvtool=gvtool, format=format)
+
+
+if __name__ == "__main__":
+    main()
+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+
+import os
+import sys
+from distutils.core import setup
+
+sys.path.insert(0, "src")
+
+from pyrels import __version__, __date__, __license__, __author__
+
+
+setupCommand = sys.argv[1]
+
+
+# first try converting README from ReST to HTML, if Docutils is installed
+# (else issue a warning)
+
+if setupCommand in ("sdist", "build"):
+    toolName = "rst2html.py"
+    res = os.popen("which %s" % toolName).read().strip()
+    if res.endswith(toolName):
+        cmd = "%s '%s' '%s'" % (res, "README.txt", "README.html")
+        print "running command %s" % cmd
+        cmd = os.system(cmd)
+    else:
+        print "Warning: No '%s' found. 'README.{txt|html}'" % toolName,
+        print "might be out of synch."
+
+
+# description for Distutils to do its business
+
+baseURL = "http://www.dinu-gherman.net/"
+
+setup(
+    name = "pyrels",
+    version = __version__,
+    description = "A tool for displaying relationships between Python objects.",
+    long_description = """\
+A tool for displaying relationships between Python objects. 
+Currently pyrels takes Python namespaces and generates graphs 
+in the GraphViz DOT format that describe Python datastructures 
+and references from names to objects.""",
+    date = __date__,
+    author = __author__,
+    author_email = "gherman@darwin.in-berlin.de",
+    maintainer = __author__,
+    maintainer_email = "gherman@darwin.in-berlin.de",
+    license = __license__,
+    platforms = ["Posix", "Windows"],
+    keywords = ["visualizing", "Python", "relationships", "references", "namespaces"],
+    url = baseURL,
+    download_url = baseURL + "tmp/pyrels-%s.tar.gz" % __version__,
+    package_dir = {"pyrels": "src/pyrels"},
+    packages = ["pyrels"],
+    scripts = ["scripts/pyrels"],
+    classifiers = [
+        "Development Status :: 3 - Alpha",
+        "Environment :: Console",
+        "Intended Audience :: Developers",
+        "Intended Audience :: End Users/Desktop",
+        "Intended Audience :: Education",
+        "License :: OSI Approved :: GNU General Public License (GPL)",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Topic :: Education",
+        "Topic :: Software Development",
+        "Topic :: Scientific/Engineering :: Visualization",
+    ],
+)
+

src/pyrels/__init__.py

+__version__ = "0.1.0"
+__license__ = "GNU General Public Licence v3 (GPLv3)"
+__author__ = "Dinu Gherman"
+__date__ = "2008-07-08"

src/pyrels/pyrels2dot.py

+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+
+"A tool for visualizing Python namespaces as GraphViz DOT files."
+
+# TODO:
+#   - make proper node class generating DOT description for __str__
+#   - handle cyclic datastructures
+
+
+import re, sys, os
+from types import *
+
+# make sure we have decimal package
+try:
+    import decimal
+except ImportError:
+    raise
+
+
+from utils import uniq
+
+
+__version__ = "0.1.0"
+__license__ = "GPL 3"
+__author__ = "Dinu Gherman"
+__date__ = "2008-06-18"
+
+
+RECURSION_COUNT = 0
+
+
+class PyName(object):
+    def __init__(self, name):
+        self.name = name
+
+
+# helpers
+
+def typeID(obj):
+    "Return type name from description returned by type() plus obj ID."
+    
+    # e.g. typeID(12) -> "int123456"
+    
+    if obj is None:
+        return "none"
+    typ = re.search("'(.*)'", str(type(obj))).groups()[0]
+    typ = typ.replace(".", "_")
+    typ = typ.replace("-", "_")
+    if type(obj) == BooleanType:
+        return typ
+    else:
+        return "%s%d" % (typ, id(obj))
+
+
+def addObject(ns, name, obj, nodes, edges, debug=False):
+    "Add objects (recursively) to a list of nodes and a list of edges."
+    
+    global RECURSION_COUNT
+    RECURSION_COUNT += 1
+    if RECURSION_COUNT > 1000:
+        return nodes, edges
+
+    refString = ""
+    compositionString = ""
+    
+    if debug:
+        print "handling name '%s'" % name
+
+    typ = re.search("'(.*)'", str(type(obj))).groups()[0]
+    ID = typeID(obj)
+    # if "." in typ or "-" in typ:
+    #    ID = '"%s"' % ID
+    objType = type(obj)
+
+    # add node for name
+    if name in ns.keys():
+        nodes.append((typeID(name).replace("str", "name"), name))
+        edges.append((typeID(name).replace("str", "name"), ID))
+
+    # handle objects
+    # None
+    if objType == NoneType:
+        nodes.append((ID, obj))
+    # booleans
+    elif objType == BooleanType:
+        nodes.append((ID, obj))
+    # numbers
+    elif objType in (IntType, FloatType, ComplexType, LongType):
+        nodes.append((ID, obj))
+    # strings
+    elif objType in (StringType, UnicodeType):
+        nodes.append((ID, obj))
+    # decimals
+    elif isinstance(obj, decimal.Decimal):
+        nodes.append((ID, obj))
+
+    # compositions
+    # lists and tuples
+    elif objType in (ListType, TupleType):
+        nodes.append((ID, obj))
+        # add list/tuple content from record
+        for i in range(len(obj)):
+            addObject(ns, None, obj[i], nodes, edges, debug=debug)
+    # dictionaries (DictProxyType, DictionaryType?)
+    elif objType == DictType:
+        # make dict record
+        nodes.append((ID, obj))
+        # add dict content from dict record
+        for i in range(len(obj.keys())):
+            k, v = obj.keys()[i], obj[obj.keys()[i]]
+            addObject(ns, None, k, nodes, edges, debug=debug)
+            addObject(ns, None, v, nodes, edges, debug=debug)
+    # sets and frozensets
+    elif sys.version_info[:2] >= (2, 4) and type(obj) in (set, frozenset):
+        nodes.append((ID, obj))
+        # add set content from record
+        for ob in obj:
+            addObject(ns, None, ob, nodes, edges, debug=debug)
+
+    # xranges
+    elif objType == XRangeType:
+        nodes.append((ID, obj))
+    # slices
+    elif objType == type(slice(1,10)):
+        nodes.append((ID, obj))
+    # ellipsis
+    elif objType == EllipsisType:
+        nodes.append((ID, obj))
+
+    # files
+    elif objType == FileType:
+        nodes.append((ID, obj))
+
+    # iterators
+    elif objType in map(type, map(iter, [{}, [], (1,)])):
+        nodes.append((ID, obj))
+
+    # modules, functions, classes
+    elif objType in (FunctionType, BuiltinFunctionType, ModuleType, 
+        ClassType, MethodType):
+        nodes.append((ID, obj))
+    # new style classes
+    elif objType == TypeType and hasattr(obj, "__class__"):
+        nodes.append((ID, obj))
+    # instances
+    elif objType in (InstanceType, ObjectType):
+        nodes.append((ID, obj))
+    # exceptions
+    elif objType == TypeType and issubclass(obj, Exception):
+        nodes.append((ID, obj))
+    # generators
+    elif objType == GeneratorType:
+        nodes.append((ID, obj))
+    # code
+    elif objType == CodeType:
+        nodes.append((ID, obj))
+
+    # regular expressions
+    elif objType == type(re.compile("a+")):
+        nodes.append((ID, obj))
+    else:
+        msg = "cannot handle type:"
+        args = tuple([msg] + map(repr, [name, obj, ID, objType]))
+        print "%s: name: %s, obj: %s, ID: %s, objType: %s" % args
+        
+    if False:
+        print "nodes:" 
+        for n in nodes:
+            print n
+
+    return nodes, edges
+
+
+def toDot(nodes, edges, debug=False):
+    "Convert nodes/edges to DOT format."
+    
+    nameNodeFormat = '''    %s [label="%s", shape="ellipse"];'''
+    objNodeFormat = '''    %s [label="%s", shape="box"];'''
+    listNodeFormat = '''    %s [label="list: | %s", shape="record"];'''
+    tupleNodeFormat = '''    %s [label="tuple: | %s", shape="Mrecord"];'''
+    dictNodeFormat = '''    %s [label="%s", shape="record"];'''
+    setNodeFormat = '''    %s [label="set: | %s", shape="record"];'''
+    fsetNodeFormat = '''    %s [label="frozenset: | %s", shape="record"];'''
+    edgeFormat = '''    %s -> %s [label="%s"];'''
+
+    refString = "ref"
+    compositionString = ""
+
+    dotNodes, dotEdges = [], []    
+    # handle nodes
+    for (ID, obj) in nodes:
+        if 0 and ID == None:
+            # None
+            dotNodes.append(objNodeFormat % (ID, ID))
+            continue
+        
+        try:
+            prefix = re.search("^([a-zA-Z_]+)", ID).group()
+        except:
+            print "raising", ID
+            raise
+
+        # Python names
+        if ID.startswith("name"):
+            dotNodes.append(nameNodeFormat % (ID, obj))
+        # None
+        elif ID.startswith("none"):
+            label = str(obj)
+            dotNodes.append(objNodeFormat % (ID, label))
+        # booleans
+        elif ID.startswith("bool"):
+            label = "%s: %s" % (ID, str(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+        # numbers
+        elif prefix in ("int", "float", "complex", "long"):
+            label = "%s: %s" % (prefix, obj)
+            dotNodes.append(objNodeFormat % (ID, label))
+        # strings
+        elif prefix in ("str", "unicode"):
+            label = "%s: %s" % (prefix, repr(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+        # decimals
+        elif ID.startswith("decimal_Decimal"):
+            label = '%s: \\"%s\\"' % ("decimal", str(obj))
+            dotNodes.append(objNodeFormat % (repr(ID).replace("'", '"'), label))
+
+        # compositions
+        # lists and tuples
+        if prefix in ("list", "tuple"):
+            # make list/tuple record
+            structLabel = "|".join(["<%d> %d" % (i, i) for i in range(len(obj))])
+            lnf, tnf = [listNodeFormat, tupleNodeFormat]
+            format = {True:lnf}.get(prefix=="list", tnf)
+            dotNodes.append(format % (ID, structLabel))
+            # add list/tuple connections from record
+            for i in range(len(obj)):
+                args = ("%s:%d" % (ID, i), typeID(obj[i]), compositionString)
+                if not edgeFormat % args in dotEdges:
+                    dotEdges.append(edgeFormat % args)
+        # dictionaries (DictProxyType, DictionaryType?)
+        elif prefix == "dict":
+            # make dict record
+            label = "%s: %s" % (prefix, obj)
+            items = range(len(obj.items()))
+            structEntries = ["{<k%d>|<v%d>}" % (i, i) for i in items]
+            structLabel = "|".join(["dict: | {keys|vals}"] + structEntries)
+            dotNodes.append(dictNodeFormat % (ID, structLabel))
+            # add dict connections from dict record
+            for i in range(len(obj.keys())):
+                k, v = obj.keys()[i], obj[obj.keys()[i]]
+                args = ("%s:k%d" % (ID, i), typeID(k), compositionString)
+                dotEdges.append(edgeFormat % args)
+                args = ("%s:v%d" % (ID, i), typeID(v), compositionString)
+                dotEdges.append(edgeFormat % args)
+        # sets and frozensets
+        elif prefix in ("set", "frozenset"):
+            # make record
+            structLabel = "|".join(["<%d> %d" % (i, i) for i in range(len(obj))])
+            snf, fsnf = [setNodeFormat, fsetNodeFormat]
+            format = {True:snf}.get(type(obj) is set,fsnf)
+            dotNodes.append(format % (ID, structLabel))
+            # add set connections from record
+            for i in range(len(obj)):
+                sobj = sorted(obj)
+                args = ("%s:%d" % (ID, i), typeID(sobj[i]), compositionString)
+                dotEdges.append(edgeFormat % args)
+
+        # xranges
+        elif prefix == "xrange":
+            label = "%s: %s" % (prefix, str(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+        # slices
+        elif prefix == "slice":
+            label = "%s: %s" % (prefix, str(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+        # ellipsis
+        elif prefix == "ellipsis":
+            label = "%s: %s" % (prefix, id(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+        # files
+        elif prefix == "file":
+            label = "%s: %s" % (prefix, obj.name)
+            dotNodes.append(objNodeFormat % (ID, label))
+        # iterators
+        elif prefix in ("listiterator", "tupleiterator", "dictionary_keyiterator"):
+            label = "%s: %s" % (prefix, str(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+
+        # modules, functions, classes
+        if prefix in ("function", "builtin_function_or_method", "module", 
+            "classobj", "instancemethod"):
+            label = "%s: %s" % (prefix, obj.__name__)
+            dotNodes.append(objNodeFormat % (ID, label))
+        # new style classes
+        if prefix == "type" and hasattr(obj, "__class__"):
+            label = "%s: %s" % ("new style class", obj.__name__)
+            dotNodes.append(objNodeFormat % (ID, label))
+        # instances
+        elif prefix in ("instance", "__main__"):
+            label = "%s (%s): %s" % (prefix, obj.__class__.__name__, id(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+
+        # exceptions
+        if prefix == "type" and issubclass(obj, Exception):
+            label = "%s: %s" % ("exception", obj.__name__)
+            dotNodes.append(objNodeFormat % (ID, label))
+        # regular expressions
+        elif prefix == "_sre_SRE_Pattern":
+            label = "%s: %s" % ("regexPattern", str(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+
+        # generators
+        elif prefix == "generator":
+            label = "%s: %s" % (prefix, id(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+        # code
+        elif prefix == "code":
+            label = "%s: %s" % (prefix, id(obj))
+            dotNodes.append(objNodeFormat % (ID, label))
+
+    # handle edges
+    for (start, end) in edges:
+        startTag = start
+        endTag = end
+        dotEdges.append(edgeFormat % (startTag, endTag, refString))
+
+    return dotNodes, dotEdges
+    
+
+    if 1:
+        pass
+    else:
+        msg = "cannot handle type:"
+        args = tuple([msg] + map(repr, [name, obj, ID, objType]))
+        print "%s: name: %s, obj: %s, ID: %s, objType: %s" % args
+        
+    if False:
+        print "nodes:" 
+        for n in nodes:
+            print n
+
+    return nodes, edges
+
+
+def ns2dot(ns, skipNames=["__builtins__"], debug=False):
+    "Calculate and return nodes and edges for some namespace."
+    
+    nodes, edges = [], []
+    
+    for name, obj in ns.items():
+        if obj == ns:
+            continue
+        if name in skipNames:
+            continue
+        if name in ns.keys():
+            addObject(ns, name, obj, nodes, edges, debug=debug)
+
+    # nodes = uniq(nodes)
+    # edges = uniq(edges)
+    
+    # return nodes, edges
+    # print nodes
+    # print edges
+    nodes, edges = toDot(nodes, edges)
+    return nodes, edges
+    
+
+def namespace2dot(ns, path=None, gvtool=None, format="pdf", debug=False):
+    "Generate GraphViz DOT file for a given namespace." 
+    
+    nodes, edges = ns2dot(ns, debug=debug)
+
+    # create DOT file
+    if type(path) == str:
+        f = open(path, "w")
+    else: 
+        f = path
+    write = lambda line: f.write("%s\n" % line)
+    write("digraph G {")
+    write("    overlap=false;")
+    # write("    concentrate=true;")
+    # write("    nodesep=1.0;")
+    write("")
+    for n in nodes: 
+        write(n)
+    write("")
+    for e in edges: 
+        write(e)
+    write("")
+    write("}")
+    if type(path) == str:
+        f.close()
+    
+    # convert resulting DOT file into another format
+    if type(gvtool) == str:
+        main = os.path.splitext(path)[0]
+        args = (gvtool, format, main+"."+format, path)
+        cmd = '''%s -T%s -o "%s" "%s"''' % args
+        # print "running '%s'" % cmd
+        os.popen(cmd)
+
+
+def _main(ns, path=None, gvtool=None, format="pdf", debug=False):
+    "Generate GraphViz DOT file for a given namespace." 
+
+    namespace2dot(ns, path=path, gvtool=gvtool, format=format, debug=debug)
+
+
+if __name__ == "__main__":
+    _main()

src/pyrels/utils.py

+#!/usr/bin/env python
+# -*- coding: UTF-8 -*-
+
+"Utilities for pyrels."
+
+
+def uniq(aList):
+    "Make all elements in a list unique."
+    
+    set = {}
+    return [set.setdefault(e, e) for e in aList if e not in set]

test/output/BasicTests.test.aBool.dot

+digraph G {
+    overlap=false;
+
+    name3412000 [label="aBool", shape="ellipse"];
+    bool [label="bool: True", shape="box"];
+
+    name3412000 -> bool [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aBool.pdf

Binary file added.

test/output/BasicTests.test.aBuiltinFunction.dot

+digraph G {
+    overlap=false;
+
+    name3322808 [label="aBuiltinFunction", shape="ellipse"];
+    builtin_function_or_method1640808 [label="builtin_function_or_method: len", shape="box"];
+
+    name3322808 -> builtin_function_or_method1640808 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aBuiltinFunction.pdf

Binary file added.

test/output/BasicTests.test.aClass.dot

+digraph G {
+    overlap=false;
+
+    name3412640 [label="aClass", shape="ellipse"];
+    classobj3398224 [label="classobj: Klass", shape="box"];
+
+    name3412640 -> classobj3398224 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aClass.pdf

Binary file added.

test/output/BasicTests.test.aCode.dot

+digraph G {
+    overlap=false;
+
+    name3412736 [label="aCode", shape="ellipse"];
+    code3271664 [label="code: 3271664", shape="box"];
+
+    name3412736 -> code3271664 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aCode.pdf

Binary file added.

test/output/BasicTests.test.aComplex.dot

+digraph G {
+    overlap=false;
+
+    name3412160 [label="aComplex", shape="ellipse"];
+    complex1634648 [label="complex: (3+4j)", shape="box"];
+
+    name3412160 -> complex1634648 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aComplex.pdf

Binary file added.

test/output/BasicTests.test.aDecimal.dot

+digraph G {
+    overlap=false;
+
+    name3412288 [label="aDecimal", shape="ellipse"];
+    "decimal_Decimal3664072" [label="decimal: \"2.0\"", shape="box"];
+
+    name3412288 -> decimal_Decimal3664072 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aDecimal.pdf

Binary file added.

test/output/BasicTests.test.aDict.dot

+digraph G {
+    overlap=false;
+
+    name3412448 [label="aDict", shape="ellipse"];
+    dict3666688 [label="dict: | {keys|vals}|{<k0>|<v0>}", shape="record"];
+    int8402300 [label="int: 2", shape="box"];
+    int8402276 [label="int: 4", shape="box"];
+
+    dict3666688:k0 -> int8402300 [label=""];
+    dict3666688:v0 -> int8402276 [label=""];
+    name3412448 -> dict3666688 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aDict.pdf

Binary file added.

test/output/BasicTests.test.aDictKeyIterator.dot

+digraph G {
+    overlap=false;
+
+    name3322728 [label="aDictKeyIterator", shape="ellipse"];
+    dictionary_keyiterator3661760 [label="dictionary_keyiterator: <dictionary-keyiterator object at 0x37dfc0>", shape="box"];
+
+    name3322728 -> dictionary_keyiterator3661760 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aDictKeyIterator.pdf

Binary file added.

test/output/BasicTests.test.aFile.dot

+digraph G {
+    overlap=false;
+
+    name3412576 [label="aFile", shape="ellipse"];
+    file3391952 [label="file: test_basic.py", shape="box"];
+
+    name3412576 -> file3391952 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aFile.pdf

Binary file added.

test/output/BasicTests.test.aFloat.dot

+digraph G {
+    overlap=false;
+
+    name3412128 [label="aFloat", shape="ellipse"];
+    float8617908 [label="float: 3.14", shape="box"];
+
+    name3412128 -> float8617908 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aFloat.pdf

Binary file added.

test/output/BasicTests.test.aFrozenSet.dot

+digraph G {
+    overlap=false;
+
+    name3322568 [label="aFrozenSet", shape="ellipse"];
+    frozenset3518992 [label="frozenset: | <0> 0|<1> 1|<2> 2", shape="record"];
+    int8402312 [label="int: 1", shape="box"];
+    int8402300 [label="int: 2", shape="box"];
+    int8402288 [label="int: 3", shape="box"];
+
+    frozenset3518992:0 -> int8402312 [label=""];
+    frozenset3518992:1 -> int8402300 [label=""];
+    frozenset3518992:2 -> int8402288 [label=""];
+    name3322568 -> frozenset3518992 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aFrozenSet.pdf

Binary file added.

test/output/BasicTests.test.aFunction.dot

+digraph G {
+    overlap=false;
+
+    name3322768 [label="aFunction", shape="ellipse"];
+    function3654512 [label="function: foo", shape="box"];
+
+    name3322768 -> function3654512 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aFunction.pdf

Binary file added.

test/output/BasicTests.test.aGenerator.dot

+digraph G {
+    overlap=false;
+
+    name3322968 [label="aGenerator", shape="ellipse"];
+    generator3664232 [label="generator: 3664232", shape="box"];
+
+    name3322968 -> generator3664232 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aGenerator.pdf

Binary file added.

test/output/BasicTests.test.aHex.dot

+digraph G {
+    overlap=false;
+
+    name3412096 [label="aHex", shape="ellipse"];
+    int8645744 [label="int: 291", shape="box"];
+
+    name3412096 -> int8645744 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aHex.pdf

Binary file added.

test/output/BasicTests.test.aList.dot

+digraph G {
+    overlap=false;
+
+    name3412384 [label="aList", shape="ellipse"];
+    list3613400 [label="list: | <0> 0|<1> 1|<2> 2", shape="record"];
+    int8402312 [label="int: 1", shape="box"];
+    int8402300 [label="int: 2", shape="box"];
+    int8402288 [label="int: 3", shape="box"];
+
+    list3613400:0 -> int8402312 [label=""];
+    list3613400:1 -> int8402300 [label=""];
+    list3613400:2 -> int8402288 [label=""];
+    name3412384 -> list3613400 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aList.pdf

Binary file added.

test/output/BasicTests.test.aListIterator.dot

+digraph G {
+    overlap=false;
+
+    name3322648 [label="aListIterator", shape="ellipse"];
+    listiterator3661712 [label="listiterator: <listiterator object at 0x37df90>", shape="box"];
+
+    name3322648 -> listiterator3661712 [label="ref"];
+
+}
Add a comment to this file

test/output/BasicTests.test.aListIterator.pdf

Binary file added.

test/output/BasicTests.test.aLong.dot