Commits

Stan Seibert committed 552650e Merge
  • Participants
  • Parent commits abd178a, 5837bf0

Comments (0)

Files changed (7)

File doc/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/shrinkwrap.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/shrinkwrap.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/shrinkwrap"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/shrinkwrap"
+	@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."
+API Documentation
+=================
+
+``shrinkwrap.install``
+----------------------
+.. automodule:: shrinkwrap.install
+   :members:
+
+``shrinkwrap.command``
+----------------------
+.. automodule:: shrinkwrap.command
+   :members:
+
+# -*- coding: utf-8 -*-
+#
+# shrinkwrap documentation build configuration file, created by
+# sphinx-quickstart on Mon Sep 17 21:52:51 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
+
+# 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']
+
+# 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'shrinkwrap'
+copyright = u'2012, Stan Seibert'
+
+# 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 = '0.6'
+# The full version, including alpha/beta/rc tags.
+release = '0.6'
+
+# 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 = 'shrinkwrapdoc'
+
+
+# -- 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', 'shrinkwrap.tex', u'shrinkwrap Documentation',
+   u'Stan Seibert', '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', 'shrinkwrap', u'shrinkwrap Documentation',
+     [u'Stan Seibert'], 1)
+]

File doc/index.rst

+Welcome to shrinkwrap's documentation!
+======================================
+Shrinkwrap provides tools to create Python package wrappers around non-Python software, and to install such software in a Pythonic way.
+
+Shrinkwrapped packages can be uploaded to a Python package index, facilitating project-specific repositories that leverage familiar tools such as pip and virtualenv.
+
+Shrinkwrap is `available on PyPI <http://pypi.python.org/pypi/shrinkwrap/0.7>`_ and can be installed via ``pip install shrinkwrap``, ``easy_install shrinkwrap``, or by downloading the package and installing with ``python setup.py install``.
+
+For those interested in the newest features should use the development version of shrinkwrap, `available on bitbucket <https://bitbucket.org/seibert/shrinkwrap>`_::
+
+    hg clone https://bitbucket.org/seibert/shrinkwrap
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   packaging
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

File doc/packaging.rst

+Creating Packages
+=================
+Writing wrapper packages
+------------------------
+The goal of shrinkwrap is to create Python packages for non-Python software and install them using Python package management. To this end, shrinkwrap "packages" are simply setuptools setup scripts which know how to download and install other software.
+
+A shrinkwrap package may either use a built-in installer function (for common installation methods) or define a custom one.
+
+Built-in installers
+```````````````````
+An installer for software using autoconf is available to simplify things. For example, to package `curl`, one may write the following (as, e.g. `curl-7.27.0.py`)::
+
+    try:
+        from shrinkwrap.install import ShrinkwrapInstall
+    except ImportError:
+        import subprocess; subprocess.check_call('pip install shrinkwrap', shell=True)
+        from shrinkwrap.install import ShrinkwrapInstall
+    from setuptools import setup
+
+
+    version = '7.27.0'
+
+    setup(
+        name='curl',
+        version=version,
+        author='Stan Seibert',
+        author_email='stan@mtrr.org',
+        shrinkwrap_installer='autoconf',
+        shrinkwrap_source_url='http://curl.haxx.se/download/curl-%s.tar.bz2' % version,
+        cmdclass={'install': ShrinkwrapInstall},
+    )
+
+To install curl, one would simply run::
+
+    python curl-7.27.0.py install
+
+The boilerplate at the top of the script is required to ensure that shrinkwrap is installed before setuptools is imported.
+
+The filename of the python script is not used by shrinkwrap.
+
+Custom installers
+`````````````````
+The following package for bzip2 illustrates a custom installer function::
+
+    try:
+        from shrinkwrap.install import ShrinkwrapInstall
+    except ImportError:
+        import subprocess; subprocess.check_call('pip install shrinkwrap', shell=True)
+        from shrinkwrap.install import ShrinkwrapInstall
+    import os
+    from setuptools import setup
+
+
+    version = '1.0.6'
+    source_url = 'http://www.bzip.org/%(version)s/bzip2-%(version)s.tar.gz' % {'version': version}
+
+
+    def installer(self):
+        self.download_and_unpack_tarball(source_url)
+
+        bzip2_dir = 'bzip2-' + version
+        os.chdir(bzip2_dir)
+        self.make(extra_opts=['install', 'PREFIX=%s' % self.virtualenv])
+
+    setup(
+        name='bzip2',
+        version=version,
+        author='Andy Mastbaum',
+        author_email='mastbaum@hep.upenn.edu',
+        shrinkwrap_installer=installer,
+        cmdclass={'install': ShrinkwrapInstall},
+    )
+
+As before, installing bzip2 simply requires::
+
+    python bzip2-1.0.6.py install
+
+Here, the ``shrinkwrap_installer`` argument to ``setup()`` is set to our own installer function. The installer uses two shrinkwrap-provided convenience functions, ``download_and_unpack_tarball`` and ``make`` to download, untar, and compile the bzip2 library. By passing extra options to make, the software is installed into the root of the active virtualenv.
+
+.. note:: For several examples of custom installers, see `https://bitbucket.org/seibert/shrinkwrap_pkgs <https://bitbucket.org/seibert/shrinkwrap_pkgs>`_.
+
+    Examples include getting code from version control, installing with cmake, and customizing install paths.
+
+Packaging for a package index
+-----------------------------
+To share shrinkwrap packages via a package index like PyPI, you must create distribution tarballs. Shrinkwrap includes a tool to create these automatically from wrapper packages::
+
+    shrinkwrap createpkg bzip2-1.0.6.py
+
+This will create a tarball suitable for uploading. Wildcards are valid, for tarring up many packages at once.
+
+Running your own package index
+------------------------------
+If you wish to serve your own package index, use the ``-p`` option to place output tarballs into one properly-formatted directory::
+
+    shrinkwrap createpkg -p packages my_shrinkwrap_pkgs/*
+
+Simply serve the `packages` directory on the web, and pip clients can interact with it just like PyPI::
+
+    client$ export PIP_EXTRA_INDEX_URL=http://your-server.com/packages/
+    client$ pip install bzip2
+

File shrinkwrap/command.py

 import optparse
 
 def activate():
+    '''Print the contents of scripts in $VIRTUAL_ENV/env.d.'''
     VIRTUAL_ENV = os.environ['VIRTUAL_ENV']
     env_pattern = os.path.join(VIRTUAL_ENV, 'env.d', '*.sh')
     if len(glob.glob(env_pattern)) > 0:
 
 
 def createpkg(argv):
+    '''Take each listed file on the command line, copy to a temporary
+    directory, rename to setup.py, run "python setup.py sdist", and copy back
+    the generated tar file.
+    
+    Streamlines the creation of shrinkwrap packages which are entirely defined
+    by a setup.py file.
+    '''
     parser = optparse.OptionParser()
     parser.add_option('-p', '--package-dir', dest='package_dir', default=None,
         help='Output packages into directory hierarchy at this location')
 
 
 def help():
+    '''Print usage for the shrinkwrap command-line utility.'''
     print '''shrinkwrap [command]
 
   activate: Echo contents of scripts in $VIRTUAL_ENV/env.d to stdout.

File shrinkwrap/install.py

+'''utilities for installing shrinkwrapped packages'''
 import tarfile
 import subprocess
 from setuptools.command import install as _install
 
 class ShrinkwrapInstall(_install.install):
     '''Base class for a setup.py "install" command that wraps a generic tarball installation.'''
-
-    
-
     def initialize_options(self):
         _install.install.initialize_options(self)
 
         with open(fullpath, 'w') as f:
             f.write(contents)
 
-#### Main command interface ####
+    #### Main command interface ####
 
     def run(self):
         '''Base implementation of the run command that install dependencies in
 
 
 def autoconf_install(self):
+    '''A convenience function to perform an autoconf-based installation.
+    
+    Note: requires parameter "shrinkwrap_source_dir" to be set in setup() call.
+    '''
     source_url = self.distribution.shrinkwrap_source_url
     source_dir = getattr(self.distribution, 'shrinkwrap_source_dir', None)