NWSGI Wiki & Documentation Rss Feed

Monday, September 28, 2009 | From Jeff Hardy's Blog

Friday, September 25, 2009 | From Jeff Hardy's Blog

Saturday, August 15, 2009 | From Jeff Hardy's Blog

Thursday, July 02, 2009 | From Jeff Hardy's Blog

Tuesday, June 30, 2009 | From Jeff Hardy's Blog

Jeff Hardy's Blog News Feed

Updated Wiki: Tutorials

jdhardy — Sat, 03 Oct 2009 16:45:48 GMT

Tutorials

Prerequisites

IronPython 2.0
NWSGI 1.0
The NWSGI HelloWorld example (included with the release)

Installation

Unzip the HelloWorld example to C:\inetpub\wwwroot\HelloWorld. Copy NWSGI.dll (skip if you used the installer) and IronPython.dll, IronPython.Modules.dll, Microsoft.Scripting.Core.dll, and Microsoft.Scripting.dll into the HelloWorld\bin folder. The HelloWorld folder should look like this:

HelloWorld\
- bin\
  - NWSGI.dll (optional)
  - IronPython.dll
  - IronPYthon.Modules.dll
  - Microsoft.Scripting.Core.dll
  - Microsoft.Scripting.dll
- hello.wsgi
- Web.Classic.config
- Web.Integrated.config

If you are using IIS7 and the installer, copy Web.Integrated.config to Web.config. Otherwise, copy Web.Classic.config to Web.config.

The next step is to point IIS at this folder. This can be done from the UI, but IIS7 has a very nice command line that is much simpler to demonstrate (be sure to run this from an elevated command prompt):

   %systemroot%\system32\inetsrv\appcmd add app /site.name:"Default Web Site" /path:/hello /physicalPath:C:\inetpub\wwwroot\HelloWorld

If you are using IIS6, then you'll have to use the UI to create the application. Also, set a script mapping for *.wsgi that points to the ASP.NET ISAPI filter (e.g. copy the path from the .aspx mapping).

Now visit http://localhost/hello/hello.wsgi. If it says "Hello, World!", then it works!

Updated Wiki: Installation

jdhardy — Sat, 03 Oct 2009 16:45:33 GMT

Installation

Installation processes will vary from server to server and application to application. Currently, IIS6 (Server 2003) and IIS7 (Vista & Server 2008) are officially supported, although Cassini (Visual Studio development server) will work as well, seeing as that's what I use for development.

Installation in general is quite simple:

Create application directory
Mark as application
Copy files
Edit web.config

It's the details of those steps that vary from server to server.

There are two supported scenarios: IIS Classic and IIS7 Integrated. IIS Classic is used when running on IIS 6, IIS 7 Classic pipeline mode, or IIS 7 without NWSGI installed. IIS7 integrated mode is available when NWSGI is installed on the server. IIS7 Integrated is the easiest scenario to deploy to as the NWSGI assembly does not need to be copied, the configuration is simpler, and it can be managed using the IIS 7 Management Console; however, it requires that the server administrator install NWSGI. IIS Classic requires the NWSGI assembly be included in the web site and a bit more configuration, with no management UI.

NWSGI works in medium trust, with two caveats: debug must be "false" (the default), and many existing Python libraries won't work in medium trust.

Steps

First, create a directory that your application will be installed. This directory will hold at least the .wsgi file that runs the application and (possibly) the NWSGI and IronPython binaries. Copy the .wsgi file into this directory.

Next, the web server needs to know that this is an application. This can be done from the UI for IIS6 and IIS7, but IIS7 has a very nice command line:

 appcmd add app /site.name:"Default Web Site" /path:/<apppath> /physicalPath:<diskpath>

Replace <apppath> with the url you wish to use, and <diskpath> with the path to the folder created in step 1.

For IIS Classic, create a bin folder and copy NWSGI.dll, Microsoft.Scripting.dll, Microsoft.Scripting.Core.dll, Microsoft.Scripting.ExtensionAttribute.dll, IronPython.dll, and IronPython.Modules.dll into it.

For IIS7 Integrated mode, create a bin folder and copy Microsoft.Scripting.dll, Microsoft.Scripting.Core.dll, Microsoft.Scripting.ExtensionAttribute.dll, IronPython.dll, and IronPython.Modules.dll into it. Unfortunately the IronPython and Microsoft.Scripting assemblies are not installed in the GAC, so they must be copied with the app.

If you are running IIS6, it needs a script mapping for *.wsgi that forwards it to the ASP.NET ISAPI dll.

Finally, edit web.config to contain:
IIS Classic:

<?xml version="1.0"?>
<configuration>
    <system.web>
        <httpHandlers>
            <add verb="*" path="*.wsgi" type="NWSGI.WsgiHandler" />
        </httpHandlers>
    </system.web>
    <system.webServer>
        <handlers>
            <add name="WsgiHandler" path="*.wsgi" verb="*"
                type="NWSGI.WsgiHandler, NWSGI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=41e64ddc1bf1fc86" 
                resourceType="Unspecified" />
        </handlers>
        <validation validateIntegratedModeConfiguration="false" />
    </system.webServer>
</configuration>

IIS7 Integrated:

    <system.webServer>
        <handlers>
            <add name="WsgiHandler" path="*.wsgi" verb="*"
                type="NWSGI.WsgiHandler, NWSGI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=41e64ddc1bf1fc86" 
                resourceType="Unspecified" />
        </handlers>
    </system.webServer>

NOTE: You must use the four part name for the type attribute if NWSGI is installed in the GAC.

You should now be able to hit http://localhost/<apppath>/<whatever>.wsgi/ and see your application.

Others

Most other ASP.NET servers (Cassini and Mono's xsp2) follow the IIS Classic instructions.

Updated Wiki: Configuration

jdhardy — Sat, 03 Oct 2009 16:45:01 GMT

Configuration

Location

NWSGI can be configured using a custom configuration section in web.config. If NWSGI is installed on IIS7 server, the <wsgi/> section is inside the <system.webServer> element.

For IIS CLassic deployments, the <wsgi /> element is inside the root <configuration> element. Add the following section to the top of your web.config:

    <configSections>
        <section name="wsgi" type="NWSGI.WsgiSection" />
    </configSections>

Details

In either case, the <wsgi /> section has the following elements (with some sample values):

    <wsgi debug="true" callable="application" enableExtenions="false" wildcardModule="~/dispatch.wsgi">
        <pythonPaths>
            <path path="C:\Users\Jeff\Documents\Repositories\PythonLibs\paste" />
        </pythonPaths>
        <wsgiEnviron>
            <variable name="CustomKey" value="CustomValue"  />
        </wsgiEnviron>
        <osEnviron>
            <variable name="DJANGO_SETTINGS_MODULE" value="mysite.settings"  />
        </osEnviron>
        <scriptMappings>
            <scriptMapping scriptName="virtual.wsgi" physicalPath="C:\HelloWorld\hello.wsgi" />
        </scriptMappings>
    </wsgi>

This allows you to manipulate NWSGI without editing the .wsgi file.

debug [true|false] (default = false)
- Initialize IronPython in Debug mode (or not).
callable (default = "application")
- The name of the application callable in the .wsgi file. This depends on the application being run; check it's documentation.
enableExtensions true (default = false)
- This enables NWSGI's extensions to the WSGI protocol. Specifically, setting it to "true" enables environ"nwsgi.context" and disables automatic response flushing (which allows the ASP.NET Session module to work properly).
wildcardModule (default = null)
- When set to a Pythoin module, NWSGI uses that module to process all requests. This is a simple way of removing the .wsgi file from URLs, but URL rewriting is strongly recommended instead.
pythonPaths
- These are added to sys.path before the .wsgi script is run.
wsgiEnviron
- These are added to the WSGI environ before the .wsgi script is run.
osEnviron
- These are added to os.environ before the .wsgi script is run.
- NOTE: These are not available in medium-trust.
- IMPORTANT: These are process-wide, so if you must use them, make sure the app is in its own AppPool.
scriptMappings
- Script mappings create a "virtual" .wsgi file that is aliased to a file that exists elsewhere in the filesystem. With a script mapping the .wsgi does not need to copied into the application's physical folder.

Updated Wiki: NWSGI 1.0

jdhardy — Sat, 03 Oct 2009 16:44:45 GMT

This is the documentation for NWSGI 1.0, which works with IronPython 2.0.

Updated Wiki: Home

jdhardy — Sat, 03 Oct 2009 16:43:51 GMT

Project Description

NWSGI is a .NET implementation of the Python WSGI specification for IronPython. It is implemented as an ASP.NET HttpHandler for use with IIS 6 and 7.

What is WSGI?

What is NWSGI?

NWSGI is an implementation of the Python WSGI spec (other implementations include wsgiref and mod_wsgi). NWSGI is implemented in .NET as an ASP.NET 2.0 HttpHandler that embeds IronPython.

Why NWSGI?

Documentation

NWSGI 1.0 Documentation

NWSGI 2.0 Documentation

NWSGI 2.0

Latest News

Jeff Hardy's Blog News Feed

Monday, September 28, 2009 | From Jeff Hardy's Blog

Friday, September 25, 2009 | From Jeff Hardy's Blog

Saturday, August 15, 2009 | From Jeff Hardy's Blog

Thursday, July 02, 2009 | From Jeff Hardy's Blog

Tuesday, June 30, 2009 | From Jeff Hardy's Blog

Jeff Hardy's Blog News Feed

Updated Wiki: Introduction

jdhardy — Sat, 03 Oct 2009 16:42:59 GMT

This page is no longer in use.

Updated Wiki: Home

jdhardy — Sat, 03 Oct 2009 16:42:18 GMT

Project Description

NWSGI is a .NET implementation of the Python WSGI specification for IronPython. It is implemented as an ASP.NET HttpHandler for use with IIS 6 and 7.

What is WSGI?

What is NWSGI?

NWSGI is an implementation of the Python WSGI spec (other implementations include wsgiref and mod_wsgi). NWSGI is implemented in .NET as an ASP.NET 2.0 HttpHandler that embeds IronPython.

Why NWSGI?

Documentation

NWSGI 1.0 Documentation

NWSGI 2.0 Documentation

NWSGI 2.0

Latest News

Jeff Hardy's Blog News Feed

Monday, September 28, 2009 | From Jeff Hardy's Blog

Friday, September 25, 2009 | From Jeff Hardy's Blog

Saturday, August 15, 2009 | From Jeff Hardy's Blog

Thursday, July 02, 2009 | From Jeff Hardy's Blog

Tuesday, June 30, 2009 | From Jeff Hardy's Blog

Jeff Hardy's Blog News Feed

Updated Wiki: NWSGI 2.0

jdhardy — Sat, 03 Oct 2009 16:41:04 GMT

To view the documentation for NWSGI 2.0, see the readme file in the download package.

Updated Wiki: Home

jdhardy — Sat, 03 Oct 2009 16:40:16 GMT

Project Description

NWSGI is a .NET implementation of the Python WSGI specification for IronPython. It is implemented as an ASP.NET HttpHandler for use with IIS 6 and 7.

NWSGI 1.0 Documentation

NWSGI 2.0 Documentation

NWSGI 2.0

Latest News

Jeff Hardy's Blog News Feed

Monday, September 28, 2009 | From Jeff Hardy's Blog

Friday, September 25, 2009 | From Jeff Hardy's Blog

Saturday, August 15, 2009 | From Jeff Hardy's Blog

Thursday, July 02, 2009 | From Jeff Hardy's Blog