README.md

falconet

What is Falcons Nest?

1. An opinionated REST API framework
2. falcon + Gevent WSGI server + REST helpers + dynamic loader for falcon
3. A simple protoduction framework in python
4. A very simple and quick way to turn Python code into a fast REST API with little effort

What Falcons Nest is not

1. A MVC framework
2. Apache or Nginx

Installation

Install from source:

$ git clone https://github.com/gknight007/falcons_nest.git
$ cd falcons_nest
$ python setup.py install

Running Examples

Lets assume you checked out the source to /tmp and have already ran the source installation steps.

$ cd /tmp/falcons_nest
$ falcons_nest -c examples/falcons_nest.cfg --loader_path ./examples

Running from the command line ...

$falcons_nest \
  --host 127.0.0.1 \
  --port 8080 \
  --pidfile /tmp/falcons_nests.pid \
  --access_log /tmp/falcons_nests.access.log \
  --error_log /tmp/falcons_nests.error.log \
  --max_logs 3 \
  --max_log_size 500 \
  --loader directory \
  --loader_path /tmp/falcons_nests/examples \
  --prefix api 

Configuration

There are 2 "things" to be configured for your applications

1. The application loader, either class path based or file system path based
2. The web service daemon. Listen host, listen port, etc...

See the config example for a details. All settings have command line overrides for config file settings. There are defaults.