Plone Application2012-10-29T13:47:27.148000Plone Foundationhttp://plone.orghttp://plone.orgenenEnglishPloneIISApphttp://plone.org4.22012-10-29T13:47:27.1480002012-10-29T13:47:27.148000Plone Application
Leading open source CMS for Content Management, Document
Management and Knowledge Management. Get your intranet, portal,
web site or community site up and running in minutes!Plone Foundationhttp://plone.orgPythonContentMgmt Plone Zope Python Server FrameworkRuntime WSGIhttp://www.sixfeetup.com/blog/plone.pnghttp://plone.org/products/plone/screenshotWDeployPython27iiswsgivirtualenvIISManagementConsole1enhttp://www.gnu.org/licenses/gpl.txt51149http://dist.plone.org/release/4.2/PloneIISApp-4.2-py2.7-win32-1.msdeploy.ziphttp://plone.org568d7613658e3bcbe438a00dd1bd196877176957%TMP%\PloneIISApp.loghttp://plone.org/downloadApplications
Plone is powerful and flexible.
It is ideal as an intranet and extranet server, as a document publishing system, a portal server and as a groupware tool for collaboration between separately located entities.
Plone is easy to use.
The Plone Team includes usability experts who have made Plone easy and attractive for content managers to add, update, and maintain content.
Plone is easy to install.
You can install Plone with a click-and-run installer, and have a content management system running on your computer in just a few minutes.
Plone is international.
The Plone interface has been translated into over 40 languages, and tools exist for managing multilingual content.
Plone is standard.
Plone carefully follows standards for usability and accessibility. Plone pages are compliant with US Section 508, and the W3C's AA rating for accessibility, in addition to using best-practice web standards like XHTML and CSS.
Plone is Open Source.
Plone is licensed under the GNU General Public License, the same license Linux uses. This gives you the right to use Plone without a license fee, and to improve upon the product.
Plone is supported.
There are over three hundred developers in the Plone Development Team around the world, and a multitude of companies specializing in Plone development and support.
Plone is extensible.
There are many add-on products for Plone that add new features and content types. In addition, Plone can be scripted using web standard solutions and Open Source languages.
Plone is technology neutral.
Plone can interoperate with most relational database systems, open source and commercial, and runs on a vast array of platforms, including Linux, Windows, Mac OS X, Solaris and BSD.
Plone is protected.
The nonprofit Plone Foundation was formed in 2004 to promote the use of Plone around the world and protect the Plone IP and trademarks.virtualenvhttp://www.virtualenv.org1.8.22012-10-29T13:47:27.1480002012-10-29T13:47:27.148000virtualenvVirtual Python Environment builderJannis Leidel, Carl Meyer and Brian RosnerPythonsetuptools deployment installation distutils%SystemDrive%\Python27\Lib\site-packages\virtualenv-1.8.2-py2.7.egg-info\PKG-INFOPython27PythonDetectInstallsPyPI1en%TMP%\pip_installhelper_27_x86.bat--log %TMP%\virtualenv.log install virtualenv==1.8.2false%TMP%\virtualenv.loghttp://www.virtualenv.orgPythonInstallation
------------
You can install virtualenv with ``pip install virtualenv``, or the `latest
development version <https://github.com/pypa/virtualenv/tarball/develop>`_
with ``pip install https://github.com/pypa/virtualenv/tarball/develop``.
You can also use ``easy_install``, or if you have no Python package manager
available at all, you can just grab the single file `virtualenv.py`_ and run
it with ``python virtualenv.py``.
.. _virtualenv.py: https://raw.github.com/pypa/virtualenv/master/virtualenv.py
What It Does
------------
``virtualenv`` is a tool to create isolated Python environments.
The basic problem being addressed is one of dependencies and versions,
and indirectly permissions. Imagine you have an application that
needs version 1 of LibFoo, but another application requires version
2. How can you use both these applications? If you install
everything into ``/usr/lib/python2.7/site-packages`` (or whatever your
platform's standard location is), it's easy to end up in a situation
where you unintentionally upgrade an application that shouldn't be
upgraded.
Or more generally, what if you want to install an application *and
leave it be*? If an application works, any change in its libraries or
the versions of those libraries can break the application.
Also, what if you can't install packages into the global
``site-packages`` directory? For instance, on a shared host.
In all these cases, ``virtualenv`` can help you. It creates an
environment that has its own installation directories, that doesn't
share libraries with other virtualenv environments (and optionally
doesn't access the globally installed libraries either).
Usage
-----
The basic usage is::
$ python virtualenv.py ENV
If you install it you can also just do ``virtualenv ENV``.
This creates ``ENV/lib/pythonX.X/site-packages``, where any libraries you
install will go. It also creates ``ENV/bin/python``, which is a Python
interpreter that uses this environment. Anytime you use that interpreter
(including when a script has ``#!/path/to/ENV/bin/python`` in it) the libraries
in that environment will be used.
It also installs either `Setuptools
<http://peak.telecommunity.com/DevCenter/setuptools>`_ or `distribute
<http://pypi.python.org/pypi/distribute>`_ into the environment. To use
Distribute instead of setuptools, just call virtualenv like this::
$ python virtualenv.py --distribute ENV
You can also set the environment variable VIRTUALENV_DISTRIBUTE.
A new virtualenv also includes the `pip <http://pypi.python.org/pypi/pip>`_
installer, so you can use ``ENV/bin/pip`` to install additional packages into
the environment.
activate script
~~~~~~~~~~~~~~~
In a newly created virtualenv there will be a ``bin/activate`` shell
script. For Windows systems, activation scripts are provided for CMD.exe
and Powershell.
On Posix systems you can do::
$ source bin/activate
This will change your ``$PATH`` so its first entry is the virtualenv's
``bin/`` directory. (You have to use ``source`` because it changes your
shell environment in-place.) This is all it does; it's purely a
convenience. If you directly run a script or the python interpreter
from the virtualenv's ``bin/`` directory (e.g. ``path/to/env/bin/pip``
or ``/path/to/env/bin/python script.py``) there's no need for
activation.
After activating an environment you can use the function ``deactivate`` to
undo the changes to your ``$PATH``.
The ``activate`` script will also modify your shell prompt to indicate
which environment is currently active. You can disable this behavior,
which can be useful if you have your own custom prompt that already
displays the active environment name. To do so, set the
``VIRTUAL_ENV_DISABLE_PROMPT`` environment variable to any non-empty
value before running the ``activate`` script.
On Windows you just do::
> \path\to\env\Scripts\activate
And type `deactivate` to undo the changes.
Based on your active shell (CMD.exe or Powershell.exe), Windows will use
either activate.bat or activate.ps1 (as appropriate) to activate the
virtual environment. If using Powershell, see the notes about code signing
below.
.. note::
If using Powershell, the ``activate`` script is subject to the
`execution policies`_ on the system. By default on Windows 7, the system's
excution policy is set to ``Restricted``, meaning no scripts like the
``activate`` script are allowed to be executed. But that can't stop us
from changing that slightly to allow it to be executed.
In order to use the script, you have to relax your system's execution
policy to ``AllSigned``, meaning all scripts on the system must be
digitally signed to be executed. Since the virtualenv activation
script is signed by one of the authors (Jannis Leidel) this level of
the execution policy suffices. As an administrator run::
PS C:\> Set-ExecutionPolicy AllSigned
Then you'll be asked to trust the signer, when executing the script.
You will be prompted with the following::
PS C:\> virtualenv .\foo
New python executable in C:\foo\Scripts\python.exe
Installing setuptools................done.
Installing pip...................done.
PS C:\> .\foo\scripts\activate
Do you want to run software from this untrusted publisher?
File C:\foo\scripts\activate.ps1 is published by E=jannis@leidel.info,
CN=Jannis Leidel, L=Berlin, S=Berlin, C=DE, Description=581796-Gh7xfJxkxQSIO4E0
and is not trusted on your system. Only run scripts from trusted publishers.
[V] Never run [D] Do not run [R] Run once [A] Always run [?] Help
(default is "D"):A
(foo) PS C:\>
If you select ``[A] Always Run``, the certificate will be added to the
Trusted Publishers of your user account, and will be trusted in this
user's context henceforth. If you select ``[R] Run Once``, the script will
be run, but you will be prometed on a subsequent invocation. Advanced users
can add the signer's certificate to the Trusted Publishers of the Computer
account to apply to all users (though this technique is out of scope of this
document).
Alternatively, you may relax the system execution policy to allow running
of local scripts without verifying the code signature using the following::
PS C:\> Set-ExecutionPolicy RemoteSigned
Since the ``activate.ps1`` script is generated locally for each virtualenv,
it is not considered a remote script and can then be executed.
.. _`execution policies`: http://technet.microsoft.com/en-us/library/dd347641.aspx
The ``--system-site-packages`` Option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you build with ``virtualenv --system-site-packages ENV``, your virtual
environment will inherit packages from ``/usr/lib/python2.7/site-packages``
(or wherever your global site-packages directory is).
This can be used if you have control over the global site-packages directory,
and you want to depend on the packages there. If you want isolation from the
global system, do not use this flag.
Environment variables and configuration files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
virtualenv can not only be configured by passing command line options such as
``--distribute`` but also by two other means:
- Environment variables
Each command line option is automatically used to look for environment
variables with the name format ``VIRTUALENV_<UPPER_NAME>``. That means
the name of the command line options are capitalized and have dashes
(``'-'``) replaced with underscores (``'_'``).
For example, to automatically install Distribute instead of setuptools
you can also set an environment variable::
$ export VIRTUALENV_DISTRIBUTE=true
$ python virtualenv.py ENV
It's the same as passing the option to virtualenv directly::
$ python virtualenv.py --distribute ENV
This also works for appending command line options, like ``--find-links``.
Just leave an empty space between the passsed values, e.g.::
$ export VIRTUALENV_EXTRA_SEARCH_DIR="/path/to/dists /path/to/other/dists"
$ virtualenv ENV
is the same as calling::
$ python virtualenv.py --extra-search-dir=/path/to/dists --extra-search-dir=/path/to/other/dists ENV
- Config files
virtualenv also looks for a standard ini config file. On Unix and Mac OS X
that's ``$HOME/.virtualenv/virtualenv.ini`` and on Windows, it's
``%APPDATA%\virtualenv\virtualenv.ini``.
The names of the settings are derived from the long command line option,
e.g. the option ``--distribute`` would look like this::
[virtualenv]
distribute = true
Appending options like ``--extra-search-dir`` can be written on multiple
lines::
[virtualenv]
extra-search-dir =
/path/to/dists
/path/to/other/dists
Please have a look at the output of ``virtualenv --help`` for a full list
of supported options.
Windows Notes
~~~~~~~~~~~~~
Some paths within the virtualenv are slightly different on Windows: scripts and
executables on Windows go in ``ENV\Scripts\`` instead of ``ENV/bin/`` and
libraries go in ``ENV\Lib\`` rather than ``ENV/lib/``.
To create a virtualenv under a path with spaces in it on Windows, you'll need
the `win32api <http://sourceforge.net/projects/pywin32/>`_ library installed.
PyPy Support
~~~~~~~~~~~~
Beginning with virtualenv version 1.5 `PyPy <http://pypy.org>`_ is
supported. To use PyPy 1.4 or 1.4.1, you need a version of virtualenv >= 1.5.
To use PyPy 1.5, you need a version of virtualenv >= 1.6.1.
Creating Your Own Bootstrap Scripts
-----------------------------------
While this creates an environment, it doesn't put anything into the
environment. Developers may find it useful to distribute a script
that sets up a particular environment, for example a script that
installs a particular web application.
To create a script like this, call
``virtualenv.create_bootstrap_script(extra_text)``, and write the
result to your new bootstrapping script. Here's the documentation
from the docstring:
Creates a bootstrap script, which is like this script but with
extend_parser, adjust_options, and after_install hooks.
This returns a string that (written to disk of course) can be used
as a bootstrap script with your own customizations. The script
will be the standard virtualenv.py script, with your extra text
added (your extra text should be Python code).
If you include these functions, they will be called:
``extend_parser(optparse_parser)``:
You can add or remove options from the parser here.
``adjust_options(options, args)``:
You can change options here, or change the args (if you accept
different kinds of arguments, be sure you modify ``args`` so it is
only ``[DEST_DIR]``).
``after_install(options, home_dir)``:
After everything is installed, this function is called. This
is probably the function you are most likely to use. An
example would be::
def after_install(options, home_dir):
if sys.platform == 'win32':
bin = 'Scripts'
else:
bin = 'bin'
subprocess.call([join(home_dir, bin, 'easy_install'),
'MyPackage'])
subprocess.call([join(home_dir, bin, 'my-package-script'),
'setup', home_dir])
This example immediately installs a package, and runs a setup
script from that package.
Bootstrap Example
~~~~~~~~~~~~~~~~~
Here's a more concrete example of how you could use this::
import virtualenv, textwrap
output = virtualenv.create_bootstrap_script(textwrap.dedent("""
import os, subprocess
def after_install(options, home_dir):
etc = join(home_dir, 'etc')
if not os.path.exists(etc):
os.makedirs(etc)
subprocess.call([join(home_dir, 'bin', 'easy_install'),
'BlogApplication'])
subprocess.call([join(home_dir, 'bin', 'paster'),
'make-config', 'BlogApplication',
join(etc, 'blog.ini')])
subprocess.call([join(home_dir, 'bin', 'paster'),
'setup-app', join(etc, 'blog.ini')])
"""))
f = open('blog-bootstrap.py', 'w').write(output)
Another example is available `here
<https://github.com/socialplanning/fassembler/blob/master/fassembler/create-venv-script.py>`_.
Using Virtualenv without ``bin/python``
---------------------------------------
Sometimes you can't or don't want to use the Python interpreter
created by the virtualenv. For instance, in a `mod_python
<http://www.modpython.org/>`_ or `mod_wsgi <http://www.modwsgi.org/>`_
environment, there is only one interpreter.
Luckily, it's easy. You must use the custom Python interpreter to
*install* libraries. But to *use* libraries, you just have to be sure
the path is correct. A script is available to correct the path. You
can setup the environment like::
activate_this = '/path/to/env/bin/activate_this.py'
execfile(activate_this, dict(__file__=activate_this))
This will change ``sys.path`` and even change ``sys.prefix``, but also allow
you to use an existing interpreter. Items in your environment will show up
first on ``sys.path``, before global items. However, global items will
always be accessible (as if the ``--system-site-packages`` flag had been used
in creating the environment, whether it was or not). Also, this cannot undo
the activation of other environments, or modules that have been imported.
You shouldn't try to, for instance, activate an environment before a web
request; you should activate *one* environment as early as possible, and not
do it again in that process.
Making Environments Relocatable
-------------------------------
Note: this option is somewhat experimental, and there are probably
caveats that have not yet been identified. Also this does not
currently work on Windows.
Normally environments are tied to a specific path. That means that
you cannot move an environment around or copy it to another computer.
You can fix up an environment to make it relocatable with the
command::
$ virtualenv --relocatable ENV
This will make some of the files created by setuptools or distribute
use relative paths, and will change all the scripts to use ``activate_this.py``
instead of using the location of the Python interpreter to select the
environment.
**Note:** you must run this after you've installed *any* packages into
the environment. If you make an environment relocatable, then
install a new package, you must run ``virtualenv --relocatable``
again.
Also, this **does not make your packages cross-platform**. You can
move the directory around, but it can only be used on other similar
computers. Some known environmental differences that can cause
incompatibilities: a different version of Python, when one platform
uses UCS2 for its internal unicode representation and another uses
UCS4 (a compile-time option), obvious platform changes like Windows
vs. Linux, or Intel vs. ARM, and if you have libraries that bind to C
libraries on the system, if those C libraries are located somewhere
different (either different versions, or a different filesystem
layout).
If you use this flag to create an environment, currently, the
``--system-site-packages`` option will be implied.
The ``--extra-search-dir`` option
---------------------------------
When it creates a new environment, virtualenv installs either
setuptools or distribute, and pip. In normal operation, the latest
releases of these packages are fetched from the `Python Package Index
<http://pypi.python.org>`_ (PyPI). In some circumstances, this
behavior may not be wanted, for example if you are using virtualenv
during a deployment and do not want to depend on Internet access and
PyPI availability.
As an alternative, you can provide your own versions of setuptools,
distribute and/or pip on the filesystem, and tell virtualenv to use
those distributions instead of downloading them from the Internet. To
use this feature, pass one or more ``--extra-search-dir`` options to
virtualenv like this::
$ virtualenv --extra-search-dir=/path/to/distributions ENV
The ``/path/to/distributions`` path should point to a directory that
contains setuptools, distribute and/or pip distributions. Setuptools
distributions must be ``.egg`` files; distribute and pip distributions
should be `.tar.gz` source distributions.
Virtualenv will still download these packages if no satisfactory local
distributions are found.
If you are really concerned about virtualenv fetching these packages
from the Internet and want to ensure that it never will, you can also
provide an option ``--never-download`` like so::
$ virtualenv --extra-search-dir=/path/to/distributions --never-download ENV
If this option is provided, virtualenv will never try to download
setuptools/distribute or pip. Instead, it will exit with status code 1
if it fails to find local distributions for any of these required
packages. The local distribution lookup is done in this order and the
following locations:
#. The current directory.
#. The directory where virtualenv.py is located.
#. A ``virtualenv_support`` directory relative to the directory where
virtualenv.py is located.
#. If the file being executed is not named virtualenv.py (i.e. is a boot
script), a ``virtualenv_support`` directory relative to wherever
virtualenv.py is actually installed.
Compare & Contrast with Alternatives
------------------------------------
There are several alternatives that create isolated environments:
* ``workingenv`` (which I do not suggest you use anymore) is the
predecessor to this library. It used the main Python interpreter,
but relied on setting ``$PYTHONPATH`` to activate the environment.
This causes problems when running Python scripts that aren't part of
the environment (e.g., a globally installed ``hg`` or ``bzr``). It
also conflicted a lot with Setuptools.
* `virtual-python
<http://peak.telecommunity.com/DevCenter/EasyInstall#creating-a-virtual-python>`_
is also a predecessor to this library. It uses only symlinks, so it
couldn't work on Windows. It also symlinks over the *entire*
standard library and global ``site-packages``. As a result, it
won't see new additions to the global ``site-packages``.
This script only symlinks a small portion of the standard library
into the environment, and so on Windows it is feasible to simply
copy these files over. Also, it creates a new/empty
``site-packages`` and also adds the global ``site-packages`` to the
path, so updates are tracked separately. This script also installs
Setuptools automatically, saving a step and avoiding the need for
network access.
* `zc.buildout <http://pypi.python.org/pypi/zc.buildout>`_ doesn't
create an isolated Python environment in the same style, but
achieves similar results through a declarative config file that sets
up scripts with very particular packages. As a declarative system,
it is somewhat easier to repeat and manage, but more difficult to
experiment with. ``zc.buildout`` includes the ability to setup
non-Python systems (e.g., a database server or an Apache instance).
I *strongly* recommend anyone doing application development or
deployment use one of these tools.
Contributing
------------
Refer to the `contributing to pip`_ documentation - it applies equally to
virtualenv, except that virtualenv issues should filed on the `virtualenv
repo`_ at GitHub.
Virtualenv's release schedule is tied to pip's -- each time there's a new pip
release, there will be a new virtualenv release that bundles the new version of
pip.
.. _contributing to pip: http://www.pip-installer.org/en/latest/contributing.html
.. _virtualenv repo: https://github.com/pypa/virtualenv/
Running the tests
~~~~~~~~~~~~~~~~~
Virtualenv's test suite is small and not yet at all comprehensive, but we aim
to grow it.
The easy way to run tests (handles test dependencies automatically)::
$ python setup.py test
If you want to run only a selection of the tests, you'll need to run them
directly with nose instead. Create a virtualenv, and install required
packages::
$ pip install nose mock
Run nosetests::
$ nosetests
Or select just a single test file to run::
$ nosetests tests.test_virtualenv
Other Documentation and Links
-----------------------------
* James Gardner has written a tutorial on using `virtualenv with
Pylons
<http://wiki.pylonshq.com/display/pylonscookbook/Using+a+Virtualenv+Sandbox>`_.
* `Blog announcement
<http://blog.ianbicking.org/2007/10/10/workingenv-is-dead-long-live-virtualenv/>`_.
* Doug Hellmann wrote a description of his `command-line work flow
using virtualenv (virtualenvwrapper)
<http://www.doughellmann.com/articles/CompletelyDifferent-2008-05-virtualenvwrapper/index.html>`_
including some handy scripts to make working with multiple
environments easier. He also wrote `an example of using virtualenv
to try IPython
<http://www.doughellmann.com/articles/CompletelyDifferent-2008-02-ipython-and-virtualenv/index.html>`_.
* Chris Perkins created a `showmedo video including virtualenv
<http://showmedo.com/videos/video?name=2910000&fromSeriesID=291>`_.
* `Using virtualenv with mod_wsgi
<http://code.google.com/p/modwsgi/wiki/VirtualEnvironments>`_.
* `virtualenv commands
<https://github.com/thisismedium/virtualenv-commands>`_ for some more
workflow-related tools around virtualenv.
Status and License
------------------
``virtualenv`` is a successor to `workingenv
<http://cheeseshop.python.org/pypi/workingenv.py>`_, and an extension
of `virtual-python
<http://peak.telecommunity.com/DevCenter/EasyInstall#creating-a-virtual-python>`_.
It was written by Ian Bicking, sponsored by the `Open Planning
Project <http://openplans.org>`_ and is now maintained by a
`group of developers <https://github.com/pypa/virtualenv/raw/master/AUTHORS.txt>`_.
It is licensed under an
`MIT-style permissive license <https://github.com/pypa/virtualenv/raw/master/LICENSE.txt>`_.
Changes & News
--------------
.. warning::
Python bugfix releases 2.6.8, 2.7.3, 3.1.5 and 3.2.3 include a change that
will cause "import random" to fail with "cannot import name urandom" on any
virtualenv created on a Unix host with an earlier release of Python
2.6/2.7/3.1/3.2, if the underlying system Python is upgraded. This is due to
the fact that a virtualenv uses the system Python's standard library but
contains its own copy of the Python interpreter, so an upgrade to the system
Python results in a mismatch between the version of the Python interpreter
and the version of the standard library. It can be fixed by removing
``$ENV/bin/python`` and re-running virtualenv on the same target directory
with the upgraded Python.
1.8.2 (2012-09-06)
~~~~~~~~~~~~~~~~~~
* Updated the included pip version to 1.2.1 to fix regressions introduced
there in 1.2.
1.8.1 (2012-09-03)
~~~~~~~~~~~~~~~~~~
* Fixed distribute version used with `--never-download`. Thanks michr for
report and patch.
* Fix creating Python 3.3 based virtualenvs by unsetting the
``__PYVENV_LAUNCHER__`` environment variable in subprocesses.
1.8 (2012-09-01)
~~~~~~~~~~~~~~~~
* **Dropped support for Python 2.4** The minimum supported Python version is
now Python 2.5.
* Fix `--relocatable` on systems that use lib64. Fixes #78. Thanks Branden
Rolston.
* Symlink some additional modules under Python 3. Fixes #194. Thanks Vinay
Sajip, Ian Clelland, and Stefan Holek for the report.
* Fix ``--relocatable`` when a script uses ``__future__`` imports. Thanks
Branden Rolston.
* Fix a bug in the config option parser that prevented setting negative
options with environemnt variables. Thanks Ralf Schmitt.
* Allow setting ``--no-site-packages`` from the config file.
* Use ``/usr/bin/multiarch-platform`` if available to figure out the include
directory. Thanks for the patch, Mika Laitio.
* Fix ``install_name_tool`` replacement to work on Python 3.X.
* Handle paths of users' site-packages on Mac OS X correctly when changing
the prefix.
* Updated the embedded version of distribute to 0.6.28 and pip to 1.2.
1.7.2 (2012-06-22)
~~~~~~~~~~~~~~~~~~
* Updated to distribute 0.6.27.
* Fix activate.fish on OS X. Fixes #8. Thanks David Schoonover.
* Create a virtualenv-x.x script with the Python version when installing, so
virtualenv for multiple Python versions can be installed to the same
script location. Thanks Miki Tebeka.
* Restored ability to create a virtualenv with a path longer than 78
characters, without breaking creation of virtualenvs with non-ASCII paths.
Thanks, Bradley Ayers.
* Added ability to create virtualenvs without having installed Apple's
developers tools (using an own implementation of ``install_name_tool``).
Thanks Mike Hommey.
* Fixed PyPy and Jython support on Windows. Thanks Konstantin Zemlyak.
* Added pydoc script to ease use. Thanks Marc Abramowitz. Fixes #149.
* Fixed creating a bootstrap script on Python 3. Thanks Raul Leal. Fixes #280.
* Fixed inconsistency when having set the ``PYTHONDONTWRITEBYTECODE`` env var
with the --distribute option or the ``VIRTUALENV_USE_DISTRIBUTE`` env var.
``VIRTUALENV_USE_DISTRIBUTE`` is now considered again as a legacy alias.
1.7.1.2 (2012-02-17)
~~~~~~~~~~~~~~~~~~~~
* Fixed minor issue in `--relocatable`. Thanks, Cap Petschulat.
1.7.1.1 (2012-02-16)
~~~~~~~~~~~~~~~~~~~~
* Bumped the version string in ``virtualenv.py`` up, too.
* Fixed rST rendering bug of long description.
1.7.1 (2012-02-16)
~~~~~~~~~~~~~~~~~~
* Update embedded pip to version 1.1.
* Fix `--relocatable` under Python 3. Thanks Doug Hellmann.
* Added environ PATH modification to activate_this.py. Thanks Doug
Napoleone. Fixes #14.
* Support creating virtualenvs directly from a Python build directory on
Windows. Thanks CBWhiz. Fixes #139.
* Use non-recursive symlinks to fix things up for posix_local install
scheme. Thanks michr.
* Made activate script available for use with msys and cygwin on Windows.
Thanks Greg Haskins, Cliff Xuan, Jonathan Griffin and Doug Napoleone.
Fixes #176.
* Fixed creation of virtualenvs on Windows when Python is not installed for
all users. Thanks Anatoly Techtonik for report and patch and Doug
Napoleone for testing and confirmation. Fixes #87.
* Fixed creation of virtualenvs using -p in installs where some modules
that ought to be in the standard library (e.g. `readline`) are actually
installed in `site-packages` next to `virtualenv.py`. Thanks Greg Haskins
for report and fix. Fixes #167.
* Added activation script for Powershell (signed by Jannis Leidel). Many
thanks to Jason R. Coombs.
1.7 (2011-11-30)
~~~~~~~~~~~~~~~~
* Gave user-provided ``--extra-search-dir`` priority over default dirs for
finding setuptools/distribute (it already had priority for finding pip).
Thanks Ethan Jucovy.
* Updated embedded Distribute release to 0.6.24. Thanks Alex Gronholm.
* Made ``--no-site-packages`` behavior the default behavior. The
``--no-site-packages`` flag is still permitted, but displays a warning when
used. Thanks Chris McDonough.
* New flag: ``--system-site-packages``; this flag should be passed to get the
previous default global-site-package-including behavior back.
* Added ability to set command options as environment variables and options
in a ``virtualenv.ini`` file.
* Fixed various encoding related issues with paths. Thanks Gunnlaugur Thor Briem.
* Made ``virtualenv.py`` script executable.
1.6.4 (2011-07-21)
~~~~~~~~~~~~~~~~~~
* Restored ability to run on Python 2.4, too.
1.6.3 (2011-07-16)
~~~~~~~~~~~~~~~~~~
* Restored ability to run on Python < 2.7.
1.6.2 (2011-07-16)
~~~~~~~~~~~~~~~~~~
* Updated embedded distribute release to 0.6.19.
* Updated embedded pip release to 1.0.2.
* Fixed #141 - Be smarter about finding pkg_resources when using the
non-default Python intepreter (by using the ``-p`` option).
* Fixed #112 - Fixed path in docs.
* Fixed #109 - Corrected doctests of a Logger method.
* Fixed #118 - Fixed creating virtualenvs on platforms that use the
"posix_local" install scheme, such as Ubuntu with Python 2.7.
* Add missing library to Python 3 virtualenvs (``_dummy_thread``).
1.6.1 (2011-04-30)
~~~~~~~~~~~~~~~~~~
* Start to use git-flow.
* Added support for PyPy 1.5
* Fixed #121 -- added sanity-checking of the -p argument. Thanks Paul Nasrat.
* Added progress meter for pip installation as well as setuptools. Thanks Ethan
Jucovy.
* Added --never-download and --search-dir options. Thanks Ethan Jucovy.
1.6
~~~
* Added Python 3 support! Huge thanks to Vinay Sajip and Vitaly Babiy.
* Fixed creation of virtualenvs on Mac OS X when standard library modules
(readline) are installed outside the standard library.
* Updated bundled pip to 1.0.
1.5.2
~~~~~
* Moved main repository to Github: https://github.com/pypa/virtualenv
* Transferred primary maintenance from Ian to Jannis Leidel, Carl Meyer and Brian Rosner
* Fixed a few more pypy related bugs.
* Updated bundled pip to 0.8.2.
* Handed project over to new team of maintainers.
* Moved virtualenv to Github at https://github.com/pypa/virtualenv
1.5.1
~~~~~
* Added ``_weakrefset`` requirement for Python 2.7.1.
* Fixed Windows regression in 1.5
1.5
~~~
* Include pip 0.8.1.
* Add support for PyPy.
* Uses a proper temporary dir when installing environment requirements.
* Add ``--prompt`` option to be able to override the default prompt prefix.
* Fix an issue with ``--relocatable`` on Windows.
* Fix issue with installing the wrong version of distribute.
* Add fish and csh activate scripts.
1.4.9
~~~~~
* Include pip 0.7.2
1.4.8
~~~~~
* Fix for Mac OS X Framework builds that use
``--universal-archs=intel``
* Fix ``activate_this.py`` on Windows.
* Allow ``$PYTHONHOME`` to be set, so long as you use ``source
bin/activate`` it will get unset; if you leave it set and do not
activate the environment it will still break the environment.
* Include pip 0.7.1
1.4.7
~~~~~
* Include pip 0.7
1.4.6
~~~~~
* Allow ``activate.sh`` to skip updating the prompt (by setting
``$VIRTUAL_ENV_DISABLE_PROMPT``).
1.4.5
~~~~~
* Include pip 0.6.3
* Fix ``activate.bat`` and ``deactivate.bat`` under Windows when
``PATH`` contained a parenthesis
1.4.4
~~~~~
* Include pip 0.6.2 and Distribute 0.6.10
* Create the ``virtualenv`` script even when Setuptools isn't
installed
* Fix problem with ``virtualenv --relocate`` when ``bin/`` has
subdirectories (e.g., ``bin/.svn/``); from Alan Franzoni.
* If you set ``$VIRTUALENV_DISTRIBUTE`` then virtualenv will use
Distribute by default (so you don't have to remember to use
``--distribute``).
1.4.3
~~~~~
* Include pip 0.6.1
1.4.2
~~~~~
* Fix pip installation on Windows
* Fix use of stand-alone ``virtualenv.py`` (and boot scripts)
* Exclude ~/.local (user site-packages) from environments when using
``--no-site-packages``
1.4.1
~~~~~
* Include pip 0.6
1.4
~~~
* Updated setuptools to 0.6c11
* Added the --distribute option
* Fixed packaging problem of support-files
1.3.4
~~~~~
* Virtualenv now copies the actual embedded Python binary on
Mac OS X to fix a hang on Snow Leopard (10.6).
* Fail more gracefully on Windows when ``win32api`` is not installed.
* Fix site-packages taking precedent over Jython's ``__classpath__``
and also specially handle the new ``__pyclasspath__`` entry in
``sys.path``.
* Now copies Jython's ``registry`` file to the virtualenv if it exists.
* Better find libraries when compiling extensions on Windows.
* Create ``Scripts\pythonw.exe`` on Windows.
* Added support for the Debian/Ubuntu
``/usr/lib/pythonX.Y/dist-packages`` directory.
* Set ``distutils.sysconfig.get_config_vars()['LIBDIR']`` (based on
``sys.real_prefix``) which is reported to help building on Windows.
* Make ``deactivate`` work on ksh
* Fixes for ``--python``: make it work with ``--relocatable`` and the
symlink created to the exact Python version.
1.3.3
~~~~~
* Use Windows newlines in ``activate.bat``, which has been reported to help
when using non-ASCII directory names.
* Fixed compatibility with Jython 2.5b1.
* Added a function ``virtualenv.install_python`` for more fine-grained
access to what ``virtualenv.create_environment`` does.
* Fix `a problem <https://bugs.launchpad.net/virtualenv/+bug/241581>`_
with Windows and paths that contain spaces.
* If ``/path/to/env/.pydistutils.cfg`` exists (or
``/path/to/env/pydistutils.cfg`` on Windows systems) then ignore
``~/.pydistutils.cfg`` and use that other file instead.
* Fix ` a problem
<https://bugs.launchpad.net/virtualenv/+bug/340050>`_ picking up
some ``.so`` libraries in ``/usr/local``.
1.3.2
~~~~~
* Remove the ``[install] prefix = ...`` setting from the virtualenv
``distutils.cfg`` -- this has been causing problems for a lot of
people, in rather obscure ways.
* If you use a boot script it will attempt to import ``virtualenv``
and find a pre-downloaded Setuptools egg using that.
* Added platform-specific paths, like ``/usr/lib/pythonX.Y/plat-linux2``
1.3.1
~~~~~
* Real Python 2.6 compatibility. Backported the Python 2.6 updates to
``site.py``, including `user directories
<http://docs.python.org/dev/whatsnew/2.6.html#pep-370-per-user-site-packages-directory>`_
(this means older versions of Python will support user directories,
whether intended or not).
* Always set ``[install] prefix`` in ``distutils.cfg`` -- previously
on some platforms where a system-wide ``distutils.cfg`` was present
with a ``prefix`` setting, packages would be installed globally
(usually in ``/usr/local/lib/pythonX.Y/site-packages``).
* Sometimes Cygwin seems to leave ``.exe`` off ``sys.executable``; a
workaround is added.
* Fix ``--python`` option.
* Fixed handling of Jython environments that use a
jython-complete.jar.
1.3
~~~
* Update to Setuptools 0.6c9
* Added an option ``virtualenv --relocatable EXISTING_ENV``, which
will make an existing environment "relocatable" -- the paths will
not be absolute in scripts, ``.egg-info`` and ``.pth`` files. This
may assist in building environments that can be moved and copied.
You have to run this *after* any new packages installed.
* Added ``bin/activate_this.py``, a file you can use like
``execfile("path_to/activate_this.py",
dict(__file__="path_to/activate_this.py"))`` -- this will activate
the environment in place, similar to what `the mod_wsgi example
does <http://code.google.com/p/modwsgi/wiki/VirtualEnvironments>`_.
* For Mac framework builds of Python, the site-packages directory
``/Library/Python/X.Y/site-packages`` is added to ``sys.path``, from
Andrea Rech.
* Some platform-specific modules in Macs are added to the path now
(``plat-darwin/``, ``plat-mac/``, ``plat-mac/lib-scriptpackages``),
from Andrea Rech.
* Fixed a small Bashism in the ``bin/activate`` shell script.
* Added ``__future__`` to the list of required modules, for Python
2.3. You'll still need to backport your own ``subprocess`` module.
* Fixed the ``__classpath__`` entry in Jython's ``sys.path`` taking
precedent over virtualenv's libs.
1.2
~~~
* Added a ``--python`` option to select the Python interpreter.
* Add ``warnings`` to the modules copied over, for Python 2.6 support.
* Add ``sets`` to the module copied over for Python 2.3 (though Python
2.3 still probably doesn't work).
1.1.1
~~~~~
* Added support for Jython 2.5.
1.1
~~~
* Added support for Python 2.6.
* Fix a problem with missing ``DLLs/zlib.pyd`` on Windows. Create
* ``bin/python`` (or ``bin/python.exe``) even when you run virtualenv
with an interpreter named, e.g., ``python2.4``
* Fix MacPorts Python
* Added --unzip-setuptools option
* Update to Setuptools 0.6c8
* If the current directory is not writable, run ez_setup.py in ``/tmp``
* Copy or symlink over the ``include`` directory so that packages will
more consistently compile.
1.0
~~~
* Fix build on systems that use ``/usr/lib64``, distinct from
``/usr/lib`` (specifically CentOS x64).
* Fixed bug in ``--clear``.
* Fixed typos in ``deactivate.bat``.
* Preserve ``$PYTHONPATH`` when calling subprocesses.
0.9.2
~~~~~
* Fix include dir copying on Windows (makes compiling possible).
* Include the main ``lib-tk`` in the path.
* Patch ``distutils.sysconfig``: ``get_python_inc`` and
``get_python_lib`` to point to the global locations.
* Install ``distutils.cfg`` before Setuptools, so that system
customizations of ``distutils.cfg`` won't effect the installation.
* Add ``bin/pythonX.Y`` to the virtualenv (in addition to
``bin/python``).
* Fixed an issue with Mac Framework Python builds, and absolute paths
(from Ronald Oussoren).
0.9.1
~~~~~
* Improve ability to create a virtualenv from inside a virtualenv.
* Fix a little bug in ``bin/activate``.
* Actually get ``distutils.cfg`` to work reliably.
0.9
~~~
* Added ``lib-dynload`` and ``config`` to things that need to be
copied over in an environment.
* Copy over or symlink the ``include`` directory, so that you can
build packages that need the C headers.
* Include a ``distutils`` package, so you can locally update
``distutils.cfg`` (in ``lib/pythonX.Y/distutils/distutils.cfg``).
* Better avoid downloading Setuptools, and hitting PyPI on environment
creation.
* Fix a problem creating a ``lib64/`` directory.
* Should work on MacOSX Framework builds (the default Python
installations on Mac). Thanks to Ronald Oussoren.
0.8.4
~~~~~
* Windows installs would sometimes give errors about ``sys.prefix`` that
were inaccurate.
* Slightly prettier output.
0.8.3
~~~~~
* Added support for Windows.
0.8.2
~~~~~
* Give a better warning if you are on an unsupported platform (Mac
Framework Pythons, and Windows).
* Give error about running while inside a workingenv.
* Give better error message about Python 2.3.
0.8.1
~~~~~
Fixed packaging of the library.
0.8
~~~
Initial release. Everything is changed and new!iiswsgihttp://github.com/rpatterson/iiswsgi0.32012-10-29T13:47:27.1480002012-10-29T13:47:27.148000iiswsgiServe WSGI apps using IIS's modified FastCGI support.Ross PattersonPythonfcgi iis windows%SystemDrive%\Python27\Lib\site-packages\iiswsgi-0.3-py2.7.egg-info\PKG-INFOPython27PythonDetectInstallsPyPI1en%TMP%\pip_installhelper_27_x86.bat--log %TMP%\iiswsgi.log install iiswsgi==0.3false%TMP%\iiswsgi.loghttp://github.com/rpatterson/iiswsgiPython==================================================
iiswsgi
==================================================
Serving Python WSGI applications natively from IIS
==================================================
The `iiswsgi`_ module implements a FastCGI to `WSGI`_ gateway that
is compatible with `IIS`_'s variation of the `FastCGI protocol`_. It also
provides `distutils`_ commands for building, distributing and installing
`Microsoft Web Deploy`_ (MSDeploy) packages through the `Web Platform
Installer`_ (WebPI).
.. contents::
Quick Start
===========
Assuming an existing `Python`_ distribution with a `Setup Script`_ using
`setuptools`_ and a `WSGI`_ ``*.ini`` `Paste config file`_, roughly
the following steps could be used to released to WebPI:
#. Install `iiswsgi`_ into the Python environment used to build releases::
>C:\Python27\Scripts\easy_install.exe -U iiswsgi
#. Copy the following to the dist root and adjust as appropriate:
* ``examples/pyramid.msdeploy/Manifest.xml.in``
* ``examples/pyramid.msdeploy/Parameters.xml``
* ``examples/pyramid.msdeploy/iis_install.stamp.in``
* ``examples/pyramid.msdeploy/web.config.in``
#. Add custom setup to ``setup.py``::
...
from iiswsgi import install_msdeploy
...
class install_custom_msdeploy(install_msdeploy.install_msdeploy):
def run(self):
"""Perform custom tasks."""
os.environ['WEB_CONFIG_VAR'] = 'foo'
self.pre_install()
CUSTOM_SETUP
self.post_install()
...
setup(
...
cmdclass=dict(install_msdeploy=install_custom_msdeploy),
...
#. Build a MSDeploy package::
>C:\Python27\python.exe setup.py bdist_msdeploy
#. Add WebPI dependencies to ``setup.py``::
...
setup(
...
extras_require=dict(install_msdeploy=['virtualenv'],
webpi_eggs=['virtualenv', 'iiswsgi']),
...
#. Add WebPI feed metadata to ``setup.py``:
See ``examples/pyramid.msdeploy/setup.py`` for an example.
#. Install the `Web Platform Installer`_:
#. `Install fciv.exe`_ to generate SHA1 hashes:
Must be placed on the ``%PATH%``. The recommended place would be
``%ProgramFiles%\Microsoft\Web Platform Installer`` because it's
placed on the path when WebPI is installed.
#. Build a local `WebPI feed`_::
>C:\Python27\python.exe setup.py bdist_webpi -u "{msdeploy_package_url}" -m .
#. Test locally:
#. Launch the Web Platform Installer
#. Click on the `options` link to the bottom right,
#. Enter the feed URL below and click `Add Feed`:
``file:///C:/Users/%USERNAME%/Documents/GitHub/%DIST_NAME%/dist/%DIST_NAME%-%VERSION%-py2.7-win32.webpi.xml``
#. Click `OK` and wait for WebPI to parse the feed
#. Search for your dist and install
#. Watch WebPI launch Web Matrix and open the site in a browser
#. Upload/Release::
>C:\Python27\python.exe setup.py bdist_msdeploy bdist_webpi -m . upload
If everything is working correctly, both a MSDeploy zip package and
the WebPI feed should be uploaded to `PyPI`_. Then you can instruct
users to add the feed to WebPI and they can install your package.
How it Works
============
Releasing a WSGI app on IIS involves several steps and moving pieces.
See the `Web Deploy Package Contents`_ and `IIS WSGI Tools`_ sections
for more technical details. Here is an overview of the process and
the technologies involved.
A Python Distribution
---------------------
This is a pre-requisite and is not at all specific to IIS, MSDeploy or
WebPI, only Python. This is just a directory with a ``setup.py``
`Setup Script`_ that defines the distribution and it's metadata and
very little is done differently from the standard Python `distutils`_
and `setuptools`_ ways of doing things. IOW, wherever possible,
`iiswsgi` tries to re-use ``setup.py`` metadata and where it needs new
metadata it uses `setuptools`_ `entry points`_ to add `setup kwargs`_.
Custom Set Up
-------------
If the app requires extra set up beyond just setting up a
`virtualenv`_ and installing dependencies, this can also be
implemented in ``setup.py`` by subclassing the ``install_msdeploy``
`Install MSDeploy`_ command. See the `Quick Start`_ and the `Install
MSDeploy`_ command for more details.
The MSDeploy Package
--------------------
Microsoft's Web Deploy Tool is what WebPI uses to install an IIS app
and expects a `MSDeploy package`_, simple zip file with some metadata
in it. There some `special files`_ and three ``iiswsgi`` `distutils`_
commands that help in defining and building a MSDeploy package. The
commands can also be run indiviually or run all at once by running
just the last step which will run the others first. Running them
individually is useful to debug packaging problems.
#. `Build MSDeploy Package`_ ``build_msdeploy`` command
#. `Install MSDeploy`_ ``install_msdeploy`` command
#. `Test MSDeploy`_ ``test_msdeploy`` command
#. `Build MSDeploy Distribution`_ ``bdist_msdeploy`` command
On completion of the last command a MSDeploy zip file will be in the
``dist`` directory just like any other dist command, such as
``sdist``. You can also upload the package using the ``upload``
command.
Logging output or managing verbosity for building the package is no
different than for any other disutils/setup.py uses, output is on the
console and can be redirected if you wan to capture it. See
``>C:\Python27\python.exe setup.py --help`` for more details.
The WebPI Feed
--------------
The Web Platform installer can be given additional feeds in it's
options dialog. This feed can define things that can be installed
along with their metadata including dependencies. The `bdist_webpi`_
command can build this feed as another dist file, and can thus also be
released using the ``upload`` command.
To test locally, use the ``bdist_webpi -u "{msdeploy_package_url}"``
option to put ``file:///...`` download URLs for the MSDeploy packages
in the feed. Then use the ``file:///...`` URL for the feed
itself in WebPI's options dialog that is printed to the console when
the ``bdist_webpi`` command is run.
WebPI logs information while processing the feed in the
``%LOCALAPPDATA%\Microsoft/Web Platform Installer/logs/webpi``
diretory. When debugging feed issues just look at the most recently
modified ``webpi#.txt`` file in that directory.
MSDeploy Package Installation
-----------------------------
Once the feed is included in WebPI, the entries can be searched for
and installed. After installation, but before WebPI reports
completion, any `runCommand` providers in the `MSDeploy Manifest`_ are
run which is when `iiswsgi_install.exe`_ script is invoked to find the
installed app and to run distutils setup commands, `install_msdeploy`_
and `test_msdeploy`_ by default, in that distribution. Most apps will
want to use the ``iiswsgi_install.exe -e`` option to setup a
virtualenv before running setup commands. See `MSDeploy Manifest`_
and `install_msdeploy`_ for more details and considerations.
While installing, WebPI and MSDeploy log output into
``%LOCALAPPDATA%\Microsoft/Web Platform Installer/logs/install``.
When debugging installation issues just look at the ``App Title.txt``
file in the most recently modified date-stamped direstory within that
directory. Verbosity can be controlled by adding the
``iiswsgi_install.exe -v`` option in your `Manifest.xml`_
``<runCommand path=...`` attribute. It's also often valuable to run
the `install_msdeploy` command locally in the installed app after an
installation error to debug further.
IIS Hosting
-----------
If installation has completed, there will be a
``<fastCgi><application...`` in the global IIS config, a corresponding
handler in the app's ``web.config`` and when a request comes in for
the app, IIS will invoke the handler specified. For `iiswsgi`_, the
handler will be an `paster serve`_ invocation that uses the
`egg:iiswsgi#iis`_ FCGI server. To use a general purpose `PasteDeploy
INI configuration file`_, you can use a handler like ``paster.exe
serve -s "egg:iiswsgi#iis" ...`` to use the `iiswsgi` FCGI server with
a configuration file that doesn't specify it.
IIS swallows all FCGI process output if there are any errors starting
up which can make startup issues really hard to debug. The first step
should be manually invoking the FCGI process using the ``fullPath``
and ``arguments`` attributes from the ``<application...`` element in
``web.config``. In case that doesn't reproduce the error, the
`egg:iiswsgi#iis`_ FCGI server tries to be conservative during startup
to ensure that output is logged *somewhere*. Check the following
locations for output:
* ``%IIS_USER_HOME%\Logs\%IISEXPRESS_SITENAME%\iiswsgi.log``
* ``%IIS_USER_HOME%\Logs\iiswsgi.log``
* ``%TEMP%\iiswsgi.log``
* ``\iiswsgi.log``
Verbosity is controlled by giving the ``paster serve -v...`` option to
`PasteScript`_ in the `web.config.in`_ template.
Web Deploy Package Contents
===========================
A developer releasing a MSDeploy package of a Python web app,
interacts with `iiswsgi`_ though the following files in a Python
distribution. Aside from these files, a Web Deploy package using
``iiswsgi`` is no different than any other Python distribution or
project nor should any of the ``iiswsgi`` pieces interfere with any
other uses of the same distribution. In particular, it should be
possible to build and upload MSDeploy package and WebPI feed dists in
the same command as building and uploading any other dist.
Setup Script
------------
As with other Python build, distribute, and install tasks, the
``setup.py`` script is where to control how the MSDeploy package is
built, what is distributed, and how it's installed.
Python Manifest
---------------
Use Python's source distribution `MANIFEST.in`_ template format to
declare what will be in the package.
MSDeploy Manifest
-----------------
Use the ``Manifest.xml.in`` template to generate the `Web Deploy
manifest`_. When using `iiswsgi`_, it contains a `runCommand`_
provider that invokes the ``iswsgi_install.exe`` `MSDeploy Install
Bootstrap`_ script. Most packages will want to install into a
`virtualenv`_ by including a ``-e`` option to ``iiswsgi_install.exe``.
The `build_msdeploy`_ command can be used to write `runCommand option
attributes`_ into the hash that MSDeploy uses when processing the
manifest during installation. Most apps will want to include the
``successReturnCodes="0x0"`` attribute to ensure that failures in the
command are reported back to the user. Many apps will also want to
adjust the ``waitAttempts="5"`` and/or ``waitInterval="1000"``
attributes to give the commands enough time to complete.
MSDeploy Parameters
-------------------
The `Parameters.xml`_ file defines the parameters WebPI will prompt
the user for when installing. See
``examples/pyramid.msdeploy/Parameters.xml`` for an example of using
parameters to influence custom setup.
IIS Web Config
--------------
Use the ``web.config.in`` template to generate the `IIS site
configuration file`_. When using `iiswsgi`_, it contains a `fastCgi`_
application that invokes the ``egg:iiswsgi#iis`` `iiswsgi FCGI
Gateway`_. Most packages will want to adjust the `<application...`_
attributes that control process behavior. This is also where the
``*.ini`` config file or `app_factory entry point`_ that define the
WSGI app to run are specified.
IIS Install Stamp File
----------------------
The ``iis_install.stamp.in`` template copied into place to serve as
the ``iis_install.stamp`` stamp file used by the
``iiswsgi_install.exe`` `MSDeploy Install Bootstrap`_ script to find
the right ``APPL_PHYSICAL_PATH`` at install time.
Setup Congig
------------
The `setup.cfg`_ file is only necessary if your `Setup Script`_ is not
using `setuptools`. IOW, under ``setuptools`` the commands are
automatically available is ``iiswsgi`` is installed and there's no
need for this file. Without ``setuptools``, use the following to make
the ``iiswsgi`` distutils commands available to your package::
[global]
command_packages = iiswsgi
IIS WSGI Tools
==============
The moving parts of ``iiswsgi`` are as follows:
iiswsgi FCGI Gateway
--------------------
The ``egg:iiswsgi#iis`` `paste.server_runner`_ or
`paste.server_factory`_ is the FastCGI to WSGI gateway. IIS invokes
the `paster`_ script from `PasteScript`_ with a `PasteDeploy INI
configuration file`_ to start a Python WSGI app as a FastCGI process.
Tell ``paster`` to use the IIS FCGI gateway with ``paster.exe serve -s
"egg:iiswsgi#iis" ...`` or in the `PasteDeploy INI configuration
file`_::
[server:iis]
use = egg:iiswsgi#iis
This is not intrinsically related to the `distutils`_ commands and can
be used independently of them if a project should need to.
IIS' implementation of the FastCGI protocol is not fully compliant.
Most significantly, what is passed in on `STDIN_FILENO`_ is not a
handle to an open socket but rather to a `Windows named pipe`_. This
names pipe does not support socket-like behavior, at least under
Python. As such, the ``egg:iiswsgi#iis`` gateway extends `flup's WSGI
to FCGI gateway`_ to support using ``STDIN_FILENO`` opened twice, once
each approximating the ``recv`` and ``send`` end of a socket as is
specified in FastCGI.
Build MSDeploy Package
----------------------
The ``build_msdeploy`` distutils command compiles a MSDeploy
``Manifest.xml`` converting any `runCommand`_ attributes into the
necessary hash. It will also copy into place the `IIS Install Stamp
File`_ ``iis_install.stamp`` stamp file used by the `MSDeploy Install
Bootstrap`_ ``iiswsgi_install.exe`` script to find the right
``APPL_PHYSICAL_PATH`` at install time.
Install MSDeploy
----------------
The ``install_msdeploy`` distutils command performs common actions
needed to deploy Python web apps on IIS: install dependencies, do
variable substitution in `web.config`_, and install the FastCGI
application into the IIS global config.
Since most apps will require path or parameter specific bits in the
``web.config`` file, the `install_msdeploy`_ command will perform
variable substitution while writing the ``web.config.in`` template to
``web.config``. To add variables to the substitution, just use
`Custom Set Up`_ to put them into `os.environ`_ before calling the
base class's ``run()`` method.
Since ``<fastCgi><application...`` elements don't take effect in the
``web.config``, the `install_msdeploy`_ command will use. For
reference or debugging here's an example::
> appcmd.exe set config -section:system.webServer/fastCgi /+"[fullPath='%SystemDrive%\Python27\python.exe',arguments='-u %SystemDrive%\Python27\Scripts\iiswsgi-script.py -c %HOMEDRIVE%%HOMEPATH%\Documents\My Web Sites\FooApp\test.ini',maxInstances='%NUMBER_OF_PROCESSORS%',monitorChangesTo='C:\Users\Administrator\Documents\My Web Sites\FooApp\test.ini']" /commit:apphost
See the `IIS FastCGI Reference`_ for
more details on how to configure IIS for FastCGI. Note that you
cannot use environment variable in the `monitorChangesTo` argument,
IIS will return an opaque 500 error.
This is also where to `Custom Set Up`_ by subclassing the
``install_msdeploy`` `Install MSDeploy`_ command in the ``setup.py``
`Setup Script`_ and using the distutils `cmdclass`_ kwarg to
``setup()``. See `Quick Start`_ for a small example or
``examples\pyramid.msdeploy\setup.py`` for a working example.
Test MSDeploy
-------------
The ``test_msdeploy`` distutils command uses `paster request`_ with a
`PasteDeploy INI configuration file`_ to simulate sending a request to
the app. If it fails, the command fails, making this useful to run
during `MSDeploy Package Installation`_ to ensure the user sees an
error in WebPI if the app isn't working even though the rest of the
install succeeded. See ``>C:\Python27\python.exe setup.py
test_msdeploy --help`` for more details.
Build MSDeploy Distribution
---------------------------
The ``bdist_msdeploy`` distutils command assembles an actual MSDeploy
package: It starts by running the ``build_msdeploy`` `Build MSDeploy
Package`_ command. Then it runs the ``install_msdeploy`` `Install
MSDeploy`_ command in case your package needs any of the results of
the installation process and to test the installation process.
Finally, it creates a `MSDeploy package`_ zip file with the contents
contolled by the same tools that `distutils`_ provides for ``sdist``
distributions, including ``MANIFEST.in``.
MSDeploy Install Bootstrap
--------------------------
The ``iiswsgi_install.exe`` script bootstraps the MSDeploy package
install process optionally setting up a virtualenv first. It finds
the correct ``APPL_PHYSICAL_PATH``, changes to that directory and
invokes the `Setup Script`_ with arguments.
This console script attempts to workaround the fact that WebPI and
MSDeploy don't provide any context to the app being installed.
Specifically, when using the `runCommand`_ MSDeploy provider in the
`Manifest.xml`_, the process started by ``runCommand`` has no way to
know which app it's being invoked for on install: not the current
working directory, not in an argument, nor in any environment
variable.
As such this script has to search for the app before calling it's
`Setup Script`_. It uses `appcmd.exe`_ to look in virtual directories
whose site matches the app name and which contain a stamp file still
in place. See ``>Scripts\iiswsgi_install.exe --help`` for more
details.
Build WebPI Feed Distribution
-----------------------------
The ``bdist_webpi`` distutils command assembles a WebPI feed from one
or more MSDeploy packages with dependencies. The MSDeploy packages to
include are defined by passing paths to distrubutions with
``setup.py`` files whose MSDeploy dist zip files have previously been
built in the ``--msdeploy-bdists`` command option separated by
`shlex.split`_. The download URLs for the MSDeploy zip files is
determined by expanding the ``msdeploy_url_template`` ``setup()``
kwarg with `Python string.format()`_.
The global feed metadata is taken from the distribution the command is
being run for. Entries are added to the feed for the distributions
lited in the ``--msdeploy-bdists`` command option and the
``webpi_eggs`` depdencies in `extras_require`_. The WebPI dependencies
and related products are taken from the lists given in the
``install_msdeploy`` and ``install_webpi`` ``setup()`` kwargs
respectivels. The metadata for those entries is taken from the
corresponding distributions. The following are additional ``setup()``
kwargs that are used in the feed if defined for a given distrubution:
* title
* author_url
* license_url
* display_url
* help_url
* published
* icon_url
* screenshot_url
* discovery_file
Clean WebPI Caches
------------------
The ``clean_webpi`` distutils command clears the `WebPI caches`_ for
one or more MSDeploy package downloads and the feed itself. The
MSDeploy packages to be cleared from the cache are taken from the same
``--msdeploy-bdists`` command option.
Debugging
=========
One of the more important goals of `iiswsgi`_ is to bring some greater
transparency and introspection to the process of integrating with
IIS. It's a very common experience for developers in the
non-Window/UNIX world that developing and even deploying on Windows is
much more fragile and opaque than on any other OS. Here's some of
what `iiswsgi` does to try and address that.
Graceful Degredation on non-Windows
Fist and foremost, `iiswsgi` tries to degrade gracefully when run
on non-windows platforms. Specifically, when some executable,
environment variable, or other Windows specific piece of the
environment is missing, the `iiswsgi` operation will not raise an
exception but only log an error. This allows developing and, to a
limited extent, testing MSDeploy packages on *NIX platforms. A
side-effect of this is that some errors may be missed when there
is a lot of console output from one of the `distutils`_ commands
when running *on Windows*, so check your output carefully.
Logging
Finding information about what went wrong when some part of the
process fails can be a lot more difficult on Windows than it is on
other platforms. See the sections of `How it Works`_ for where to
look for log files for each part of the process.
Known Issues
============
``System.IO.FileNotFoundException: Could not find file '\\?\C:\...``
I've run into this error on Windows 7 on two different machines
and multiple installs, one OEM and one vanilla Windows 7 Extreme.
When this happens, it seems to happen when the "Web Platform
Installer" has been run, then exited, and then run again without
rebooting the machine in between. To workaround this, you may
have to reboot the machine. See the stack overflow question `MS
WebPI package runCommand not working in Manifest.xml`_ for more
information. As such, it's not advisable to exit and re-launch
WebPI. As such, the best way to get feed changes to take effect
in WebPI may be to:
#. Click on the `options` link in the bottom right of WebPI
#. Click the `X` next to your feed to remove it
#. Click `OK` and wait for WebPI to finish updating the remaining feeds
#. Run `iiswsgi_webpi.exe`
#. Click on the `options` link again in WebPI
#. Enter the feed URL and click `Add Feed` to restore the feed
#. Click `OK` and wait for WebPI again
Now your feed changes should be reflected in WebPI.
``<fastCgi><application>`` doesn't take effect in ``web.config``
It should be possible to `register a FCGI application in the
web.config`_ file but that doesn't work. Hence
``install_msdeploy`` works around this by reading the
``web.config`` and using `AppCmd.exe`_ to do the actually FCGI app
installation. It would be much better if ``web.config`` worked as
it should. Anyone with a MS support contract, please submit a
request about this.
Can't access ``APPL_PHYSICAL_PATH`` in ``runCommand`` provider
The current method of searching for the is far too fragile and it would
be vastly preferable if MSDeploy or WebPI set the
APPL_PHYSICAL_PATH environment variable for ``runCommand``.
Anyone with a MS support contract, please submit a request about
this.
``System.IO.FileNotFoundException: Could not load file or assembly``
This error happens when using WebPI to install on full IIS, IOW
when not using IIS Express and Web Matrix. It can be worked
around by installing the "Web Deploy Tool" in WebPI. The
`bdist_webpi`_ command works around this by adding it as a
dependency for all MSDeploy packages. Here's the error from the
logs::
DownloadManager Error: 0 : System.IO.FileNotFoundException: Could not load file or assembly 'Microsoft.Web.Deployment, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35' or one of its dependencies. The system cannot find the file specified.
File name: 'Microsoft.Web.Deployment, Version=9.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35'
at Microsoft.Web.PlatformInstaller.MSDeployProxy.GetDeclaredParameters()
at Microsoft.Web.PlatformInstaller.MSDeployPackage.get_DeclaredParameters()
at Microsoft.Web.PlatformInstaller.UI.AppSitePage.GetApplicationName(MSDeployPackage package, String& appName)
at Microsoft.Web.PlatformInstaller.UI.AppSitePage.InitializeComponent()
``retrieving the com class factory for remote component CLSID 2b72133b-3f5b-4602-8952-803546CE3344 error 80040154``
This error happens when using WebPI to install on full IIS, IOW
when not using IIS Express and Web Matrix. It can be worked
around by installing the "IIS Management Console" in WebPI
dependency
WebPI Errors May be Burried
On occasion, WebPI may burry error messages behind the WebPI
window. So if WebPI has been hung for a long time, try using
``Alt-TAB`` to see if there's an error window hidden behind the
WebPI window.
WebPI getting cached feeds and MSDeploy packages
Despite the `clean_webpi`_ helper and manually clearing all the
caches under ``%LOCALAPPDATA%\Microsoft/Web Platform Installer``,
there have been several times when WebPI has still gotten stale
content causing validation errors against the SHA1 in the feed and
other problems. When this happens, a workaround may be to
download the stale WebPI resources in IE.
.. _`special files`: `Web Deploy Package Contents`_
.. _`bdist_webpi`: `Build WebPI Feed Distribution`_
.. _`clean_webpi`: `Clean WebPI Caches`_
.. _`iiswsgi_install.exe`: `MSDeploy Install Bootstrap`_
.. _`install_msdeploy`: `Install MSDeploy`_
.. _`test_msdeploy`: `Test MSDeploy`_
.. _`egg:iiswsgi#iis`: `iiswsgi FCGI Gateway`_
.. _`build_msdeploy`: `Build MSDeploy Package`_
.. _`web.config.in`: `IIS Web Config`_
.. _`Python`: http://python.org
.. _`os.environ`: http://docs.python.org/2/library/os.html#os.environ
.. _`shlex.split`: http://docs.python.org/2/library/shlex.html#shlex.split
.. _`distutils`: http://docs.python.org/distutils/
.. _`setup.cfg`: http://docs.python.org/distutils/configfile.html
.. _`cmdclass`: http://docs.python.org/distutils/extending.html#integrating-new-commands
.. _`Python string.format()`: http://docs.python.org/2/library/string.html#formatstrings
.. _`PyPI`: http://pypi.python.org/pypi
.. _`setuptools`: http://packages.python.org/distribute
.. _`entry points`: http://packages.python.org/distribute/setuptools.html#entry-points
.. _`setup kwargs`: http://packages.python.org/distribute/setuptools.html#adding-setup-arguments
.. _`extras_require`: http://packages.python.org/distribute/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies
.. _`MANIFEST.in`: http://docs.python.org/distutils/sourcedist.html#the-manifest-in-template
.. _`WSGI`: http://wsgi.readthedocs.org/en/latest/
.. _`Paste config file`: http://pythonpaste.org/deploy/#config-format
.. _`PasteDeploy INI configuration file`: http://pythonpaste.org/deploy/index.html?highlight=loadapp#introduction
.. _`PasteScript`: http://pythonpaste.org/script/#paster-serve
.. _`paster`: `PasteScript`_
.. _`paster serve`: `PasteScript`_
.. _`paster request`: http://pythonpaste.org/modules/request.html
.. _`app_factory entry point`: http://pythonpaste.org/deploy/#paste-app-factory
.. _`paste.server_runner`: http://pythonpaste.org/deploy/#paste-server-runner
.. _`paste.server_factory`: http://pythonpaste.org/deploy/#paste-server-factory
.. _`flup's WSGI to FCGI gateway`: http://trac.saddi.com/flup/wiki/FlupServers
.. _`virtualenv`: http://www.virtualenv.org
.. _`IIS`: http://www.iis.net
.. _`Microsoft Web Deploy`: http://www.iis.net/downloads/microsoft/web-deploy
.. _`Web Platform Installer`: http://www.microsoft.com/web/downloads/platform.aspx
.. _`WebPI feed`: http://technet.microsoft.com/en-us/library/ee424348(v=ws.10).aspx
.. _`WebPI caches`: http://www.iis.net/learn/troubleshoot/web-platform-installer-issues/troubleshooting-problems-with-microsoft-web-platform-installer
.. _`Install fciv.exe`: http://support.microsoft.com/kb/841290
.. _`Web Deploy manifest`: http://www.iis.net/learn/develop/windows-web-application-gallery/reference-for-the-web-application-package
.. _`Manifest.xml`: `Web Deploy manifest`_
.. _`Parameters.xml`: `Web Deploy manifest`_
.. _`MSDeploy package`: `Web Deploy manifest`_
.. _`runCommand`: http://technet.microsoft.com/en-us/library/ee619740(v=ws.10).aspx
.. _`runcommand option attributes`: `runCommand`_
.. _`IIS site configuration file`: http://technet.microsoft.com/en-us/library/cc754617(v=ws.10).aspx
.. _`web.config`: `IIS site configuration file`_
.. _`fastCgi`: http://www.iis.net/configreference/system.webserver/fastcgi
.. _`<application...`: http://www.iis.net/configreference/system.webserver/fastcgi/application
.. _`MS WebPI package runCommand not working in Manifest.xml`: http://stackoverflow.com/questions/12485887/ms-webpi-package-runcommand-not-working-in-manifest-xml/12820574#12820574
.. _`register a FCGI application in the web.config`: http://stackoverflow.com/questions/12525508/system-webserver-fastcgi-application-not-working-in-web-config
.. _`AppCmd.exe`: http://learn.iis.net/page.aspx/114/getting-started-with-appcmdexe
.. _`IIS FastCGI Reference`: http://www.iis.net/ConfigReference/system.webServer/fastCgi
.. _`FastCGI protocol`: http://www.fastcgi.com/drupal/
.. _`STDIN_FILENO`: http://www.fastcgi.com/drupal/node/6?q=node/22#S2.2
.. _`Windows named pipe`: http://msdn.microsoft.com/en-us/library/windows/desktop/aa365590(v=vs.85).aspx
Changelog
=========
0.3 - 2012-10-28
----------------
* Convert server to a Paste server
* Use distutils/setuptools commands for build and install process
0.2 - 2012-10-13
----------------
* Custom build script approach
0.1 - Unknown
----------------
* Initial releasePython