Commits

Stan Seibert committed b1a861c

Minor documentation fixes

Comments (0)

Files changed (2)

 
 A shrinkwrap package is a minimal python package that downloads, compiles and installs software to the virtualenv base directory.  The shrinkwrap package behaves just like a regular python package, so both shrinkwrap and non-shrinkwrap packages can be dependencies of each other.  We find that this greatly simplifies deployment of Python packages that depend on compiled libraries *without* requiring the use of system-wide packaging tools, like apt or yum.  Shrinkwrap is **not** an API wrapper generator like `SWIG <http://www.swig.org/>`_, but does make it easier to install C libraries into a virtualenv before installing a separate Python wrapper around its API.
 
-.. note:: To avoid cluttering PyPI with non-Python software, please do not ever upload shrinkwrap-generated packages there!  Hosting shrinkwrap packages yourself is easy, and described further in :ref:`running_package_index`.
+.. warning:: To avoid cluttering PyPI with non-Python software, please do not ever upload shrinkwrap-generated packages there!  Hosting shrinkwrap packages yourself is easy, and described further in :ref:`running_package_index`.
 
 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``.
 
 
 	pip install -e hg+http://bitbucket.org/seibert/shrinkwrap#egg=shrinkwrap
 
-Contents:
+Contents
+========
 
 .. toctree::
    :maxdepth: 2

doc/packaging.rst

 To share shrinkwrap packages via a package index like PyPI (but don't upload
 shrinkwrap packages to PyPI!!), you must create distribution tarballs.
 Shrinkwrap includes a tool to create these automatically from wrapper
-packages::
+setup.py files::
 
     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.
+This will create a tarball in the current directory suitable for uploading. Wildcards are valid for
+generating many packages at once.
+
+.. note:: You can name the python file anything you want (not just setup.py).  It will be copied to setup.py in a temp directory and the name of the resulting tarball will be derived from the package metadata you specified.
+
 
 .. _running_package_index: