Sphinx docs

.gitignore

@@ -4,3 +4,4 @@
 *.swp
 build
 dist
+docs/_build

docs/API.rst

+Pyrasite API
+============
+
+.. autoclass:: pyrasite.CodeInjector
+   :members:
+.. autoclass:: pyrasite.ObjectInspector
+   :members:
+.. autoclass:: pyrasite.PyrasiteIPC
+   :members:
+.. autoclass:: pyrasite.ReverseConnection
+   :members:
+

docs/CLI.rst

+pyrasite - A command-line interface for injecting code into running Python processes
+====================================================================================
+
+::
+
+    usage: pyrasite [-h] [--gdb-prefix GDB_PREFIX] [--verbose] pid [filename]
+
+    pyrasite - inject code into a running python process
+
+    positional arguments:
+      pid                   The ID of the process to inject code into
+      filename              The second argument must be a filename
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      --gdb-prefix GDB_PREFIX
+                            GDB prefix (if specified during installation)
+      --verbose             Verbose mode
+
+    For updates, visit https://github.com/lmacken/pyrasite
+
+
+.. seealso:: :doc:`Payloads`

docs/GUI.rst

+pyrasite-gui - A graphical interface for Pyrasite
+=================================================
+
+.. image:: http://lewk.org/img/pyrasite/pyrasite-info.png
+
+.. image:: http://lewk.org/img/pyrasite/pyrasite-stacks.png
+
+.. image:: http://lewk.org/img/pyrasite/pyrasite-objects.png
+
+.. image:: http://lewk.org/img/pyrasite/pyrasite-shell.png
+
+.. image:: http://lewk.org/img/pyrasite/pyrasite-callgraph.png

docs/Installing.rst

+Installing
+==========
+
+Requirements
+~~~~~~~~~~~~
+
+ * gdb (https://www.gnu.org/s/gdb) (version 7.3+)
+
+Download
+~~~~~~~~
+
+Download the latest stable release from PyPi: http://pypi.python.org/pypi/pyrasite
+
+::
+
+    easy_install pyrasite
+
+Grab the latest source by running:
+
+::
+
+    git clone git://git.fedorahosted.org/git/pyrasite
+
+You can also fork pyrasite on GitHub: http://github.com/lmacken/pyrasite
+
+Additional installation notes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Mac OS X
+--------
+
+If you don't want to override Apple's default gdb, install the latest version of gdb with a prefix (e.g. gnu)
+
+::
+
+    $ ./configure --program-prefix=gnu
+    $ pyrasite <PID> payloads/reverse_python_shell.py --prefix="gnu"
+
+Ubuntu
+------
+
+Since version 10.10, Ubuntu ships with a `controversial patch <https://lkml.org/lkml/2010/6/16/421>`_ that restricts the scope of ptrace, which can be disabled by running:
+
+::
+
+    echo 0 > /proc/sys/kernel/yama/ptrace_scope
+
+
+

docs/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Pyrasite.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Pyrasite.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Pyrasite"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Pyrasite"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/Payloads.rst

+Payloads
+========
+
+Reverse Python Shell
+--------------------
+
+This lets you easily introspect or alter any objects in your running process.
+
+.. literalinclude:: ../pyrasite/payloads/reverse_python_shell.py
+   :language: python
+   :start-after: Copyright
+
+::
+
+    $ python
+    >>> x = 'foo'
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/reverse_python_shell.py
+    $ nc -l localhost 9001
+    Python 2.7.1 (r271:86832, Apr 12 2011, 16:15:16)
+    [GCC 4.6.0 20110331 (Red Hat 4.6.0-2)]
+    Type 'quit' to exit.
+    >>> print x
+    foo
+    >>> globals()['x'] = 'bar'
+
+Viewing the largest objects in your process
+-------------------------------------------
+
+This payload uses `meliae <https://launchpad.net/meliae>`_ to dump all of the objects in your process to an `objects.json` file (currently dumped in the working directory of your process).
+
+.. literalinclude:: ../pyrasite/payloads/dump_memory.py
+   :language: python
+   :start-after: html
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/dump_memory.py
+
+
+Pyrasite also provides a command-line tool to view the values of largest
+objects in your process.
+
+
+::
+
+    $ pyrasite-memory-viewer <PID> objects.json
+
+
+.. image:: http://lewk.org/img/pyrasite-memory-viewer.png
+
+
+Reverse Shell
+-------------
+
+.. literalinclude:: ../pyrasite/payloads/reverse_shell.py
+   :language: python
+   :start-after: Copyright
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/reverse_shell.py
+    $ nc -l localhost 9001
+    Linux tomservo 2.6.40.3-0.fc15.x86_64 #1 SMP Tue Aug 16 04:10:59 UTC 2011 x86_64 x86_64 x86_64 GNU/Linux
+    Type 'quit' to exit.
+    % ls
+
+
+Call Graph
+----------
+
+Pyrasite comes with a payload that generates an image of your processes call
+graph using `pycallgraph <http://pycallgraph.slowchop.com>`_.
+
+.. literalinclude:: ../pyrasite/payloads/start_callgraph.py
+   :language: python
+   :start-after: http
+
+.. literalinclude:: ../pyrasite/payloads/stop_callgraph.py
+   :language: python
+   :start-after: http
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/start_callgraph.py
+    $ pyrasite <PID> pyrasite/payloads/stop_callgraph.py
+
+The callgraph is then generated using `graphviz <http://www.graphviz.org>`_ and
+saved to `callgraph.png`. You can see an example callgraph `here <http://pycallgraph.slowchop.com/pycallgraph/wiki/RegExpExample>`_.
+
+
+Viewing loaded modules
+----------------------
+
+.. literalinclude:: ../pyrasite/payloads/dump_modules.py
+   :language: python
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/dump_modules.py
+
+Dumping thread stacks
+---------------------
+
+.. literalinclude:: ../pyrasite/payloads/dump_stacks.py
+   :language: python
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/dump_stacks.py
+
+Forcing garbage collection
+---------------------------
+
+.. literalinclude:: ../pyrasite/payloads/force_garbage_collection.py
+   :language: python
+
+::
+
+    $ pyrasite <PID> pyrasite/payloads/force_garbage_collection.py

docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# Pyrasite documentation build configuration file, created by
+# sphinx-quickstart on Mon Feb 13 02:40:02 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pyrasite'
+copyright = u'2011, 2012, Luke Macken'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Pyrasitedoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Pyrasite.tex', u'Pyrasite Documentation',
+   u'Luke Macken', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'pyrasite', u'Pyrasite Documentation',
+     [u'Luke Macken'], 1)
+]

docs/index.rst

+Welcome to Pyrasite's documentation!
+====================================
+
+Pyrasite is a module and a set of tools for injecting code into running Python
+programs.
+
+:download: http://pypi.python.org/pypi/pyrasite
+:source: http://github.com/lmacken/pyrasite
+:mailing list: https://fedorahosted.org/mailman/listinfo/pyrasite
+:jenkins: http://ci.csh.rit.edu/job/pyrasite-py2.7
+
+Contents
+---------
+
+.. toctree::
+   :maxdepth: 1
+
+   Installing
+   GUI
+   CLI
+   Payloads
+
+API
+---
+
+.. autosummary::
+
+   pyrasite.CodeInjector
+   pyrasite.ObjectInspector
+   pyrasite.PyrasiteIPC
+   pyrasite.ReverseConnection

setup.py

@@ -23,6 +23,7 @@ setup(name='pyrasite',
         "meliae",
         "pycallgraph",
         "psutil",
+        "Sphinx",
       ],
       tests_require=['nose'],
       test_suite='nose.collector',