Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.49 KB

README.md

File metadata and controls

78 lines (59 loc) · 2.49 KB

Firenado Framework

master: Build Status Code Health Documentation Status

develop: Build Status develop Code Health Documentation Status

Introduction

Firenado is a web framework that extends the original Tornado Web framework adding new features like loose couple components, server side session layer, yaml based configuration files and more.

Installation

pip install firenado

Usage

Creating and running a new application:

firenado project init helloworld
cd helloworld
firenado app run

By default an application will be created with a redis based session and a redis data source defied and linked to the session.

Firenado don't install redispy so it is necessary to either install it or turn the session as file based. You can disable the session engine too.

To change the session type to file go to helloworld/conf/firenado.yaml and change the session definition to:

# Session types could be:
# file or redis.
session:
  type: file
  enabled: true
  # Redis session handler configuration
  #data:
  #  source: session
  # File session handler related configuration
  path: /tmp

If your helloworld project isn't on the python path just go helloworld/conf/firenado.yaml and configure the application settings:

app:
  component: helloworld
  data:
    sources:
        # Set here references from sources defined on data.sources
        - session
  pythonpath: ..
  port: 8888

Support

Firenado is one of [Candango Open Source Group] (http://www.candango.org/projects/) initiatives. It is available under the [Apache License, Version 2.0] (http://www.apache.org/licenses/LICENSE-2.0.html).

This web site and all documentation is licensed under [Creative Commons 3.0] (http://creativecommons.org/licenses/by/3.0/).