PyPy is the fastest way to run your Falcon app. Both PyPy2.7 and PyPy3.5 are supported as of PyPy v5.10.
$ pip install falcon
Or, to install the latest beta or release candidate, if any:
$ pip install --pre falcon
Falcon also fully supports CPython 2.7 and 3.5+.
Universal and manylinux wheels are available on PyPI for the Falcon framework. Installation is as simple as:
$ pip install falcon
Installing one of the pre-built Falcon wheels is a great way to get up and running quickly. However, when deploying your application in production, you may wish to compile Falcon via Cython yourself, using the target system’s native toolchain.
The following commands tell pip to install Cython, and then to invoke Falcon’s
setup.py, which will in turn detect the presence of Cython and then compile (AKA cythonize) the Falcon framework with the system’s default C compiler.
$ pip install cython $ pip install --no-binary :all: falcon
If you want to verify that Cython is being invoked, simply pass
-v to pip in order to echo the compilation commands:
$ pip install -v --no-binary :all: falcon
Installing on OS X
Xcode Command Line Tools are required to compile Cython. Install them with this command:
$ xcode-select --install
The Clang compiler treats unrecognized command-line options as errors, for example:
clang: error: unknown argument: '-mno-fused-madd' [-Wunused-command-line-argument-hard-error-in-future]
You might also see warnings about unused functions. You can work around these issues by setting additional Clang C compiler flags as follows:
$ export CFLAGS="-Qunused-arguments -Wno-unused-function"
Falcon does not require the installation of any other packages, although if Cython has been installed into the environment, it will be used to optimize the framework as explained above.
Falcon speaks WSGI, and so in order to serve a Falcon app, you will need a WSGI server. Gunicorn and uWSGI are some of the more popular ones out there, but anything that can load a WSGI app will do.
All Windows developers can use Waitress production-quality pure-Python WSGI server with very acceptable performance. Unfortunately Gunicorn is still not working on Windows and uWSGI need to have Cygwin on Windows installed. Waitress can be good alternative for Windows users if they want quick start using Falcon on it.
$ pip install [gunicorn|uwsgi|waitress]
Falcon lives on GitHub, making the code easy to browse, download, fork, etc. Pull requests are always welcome! Also, please remember to star the project if it makes you happy. :)
Once you have cloned the repo or downloaded a tarball from GitHub, you can install Falcon like this:
$ cd falcon $ pip install .
Or, if you want to edit the code, first fork the main repo, clone the fork to your desktop, and then run the following to install it using symbolic linking, so that when you change your code, the changes will be automagically available to your app without having to reinstall the package:
$ cd falcon $ pip install -e .
You can manually test changes to the Falcon framework by switching to the directory of the cloned repo and then running pytest:
$ cd falcon $ pip install -r requirements/tests $ pytest tests
Or, to run the default set of tests:
$ pip install tox && tox
See also the tox.ini file for a full list of available environments.
Finally, to build Falcon’s docs from source, simply run:
$ pip install tox && tox -e docs
Once the docs have been built, you can view them by opening the following index page in your browser. On OS X it’s as simple as:
$ open docs/_build/html/index.html
Or on Linux:
$ xdg-open docs/_build/html/index.html
© 2019 by Falcon contributors
Licensed under the Apache License, Version 2.0.