Welcome to whirlwind

Whirlwind is an easy-to-use MVC framework written in Python that makes efficient use of some of the fastest server-side and client-side technologies in an organized fashion. The goal of whirlwind is to speed up the configuration and development of scalable and efficient web applications. It's the glue for the seamless deployment of a combination of some useful parts of well-known and robust technologies.

The code base of whirlwind was originally developed as the underlying web framework for the social media metrics and analytics platform Trendrr.

Check out our wiki for documentation.

Need help troubleshooting, refer to our FAQ.

Setup instructions

On Ubuntu (recommended)

install python dev

sudo apt-get install python-dev

install the python setup tools

sudo apt-get install python-setuptools

upgrade setuptools

sudo easy_install -U setuptools

install required python modules

sudo easy_install tornado
sudo easy_install Mako
sudo easy_install MongoKit
sudo easy_install python-dateutil
sudo easy_install pytz

clone whirlwind

git clone git://github.com/trendrr/whirlwind.git

change to whirlwind directory

cd whirlwind

run the setup script

sudo python setup.py install

On Windows

For instructions on how to install whirlwind on windows, visit this page.

Now whirlwind is installed

Note: Before you create a whirlwind app, you should make sure you are in the directory where you want your whirlwind app to exist. Therefore, make sure to cd out of the whirlwind repository (in which you installed whirlwind) on your machine. You should preferably create a new whirwind app in your home directory.

create a whirlwind app

whirlwind-admin.py --create-application myapp

fill in env specific settings in settings file [config/settings.py]

Then cd into myapp (the name of the app you created)

# generate a cookie secret
whirlwind-admin.py --gcs

An auto-generated secret should be printed to standard output.

set the variable cookie_secret in config/settings.py to the printed out secret

cookie_secret = "setthistoyourowncookiesecret"

then start your app

python main.py

that's it! now just point your browser to the app start page to see whirlwind in action.

http://localhost:8000/

If you encounter any problems before, during, or after installation, please refer to our FAQ for troubleshooting instructions.

Copyright © 2010 Trendrr

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.