安装

PyPy

PyPy 是运行Falcon应用程序的最快方式。PYPY v5.10之后支持PYPY3.5+。

$ pip install falcon

或者,要安装最新的测试版或发布候选版(如果有):

$ pip install --pre falcon

CPython

Falcon完全支持 CPython 3.5以上。

PYPI上有一个用于Falcon框架的通用轮。安装简单如下:

$ pip install falcon

安装Falcon wheel是在开发环境中快速启动和运行的一个很好的方法,但是为了在生产环境中部署应用程序时获得额外的速度提升,Falcon可以使用Cython进行自我编译。但是请注意,Cython当前与Falcon.asgi模块。

以下命令告诉pip安装cython,然后调用falcon的 setup.py 它将依次检测Cython的存在,然后使用系统的默认C编译器编译(也称为Cythonize)Falcon框架。

$ pip install cython
$ pip install --no-binary :all: falcon

如果要验证是否正在调用Cython,只需通过 -v 要通过pip来回送编译命令,请执行以下操作:

$ pip install -v --no-binary :all: falcon

在OS X上安装

编译cython需要xcode命令行工具。使用以下命令安装它们:

$ xcode-select --install

clang编译器将无法识别的命令行选项视为错误,例如:

clang: error: unknown argument: '-mno-fused-madd' [-Wunused-command-line-argument-hard-error-in-future]

您还可能看到有关未使用函数的警告。您可以通过如下设置其他clang c编译器标志来解决这些问题:

$ export CFLAGS="-Qunused-arguments -Wno-unused-function"

依赖关系

Falcon不需要安装任何其他软件包,但如果Cython已经安装到环境中,它将用于优化上述框架。

WSGi服务器

Falcon会说wsgi,所以为了服务Falcon应用程序,您需要一个wsgi服务器。Gunicorn和Uwsgi是最受欢迎的,但是任何可以加载wsgi应用程序的东西都可以。

所有Windows开发人员都可以使用Waitress生产质量纯python wsgi服务器,其性能非常可接受。不幸的是,Gunicorn仍然不能在Windows上工作,Uwsgi需要在Windows上安装cygwin。如果Windows用户想要快速开始使用Falcon,服务员可以成为他们的好选择。

$ pip install [gunicorn|uwsgi|waitress]

源代码

Falcon lives on GitHub 使代码易于浏览、下载、分叉等。拉请求总是受欢迎的!另外,如果这个项目让你高兴的话,请记住在它上面加上星号。:)

一旦克隆了回购协议或从Github下载了tarball,就可以像这样安装falcon:

$ cd falcon
$ pip install .

或者,如果要编辑代码,请首先分叉主repo,将分叉克隆到桌面,然后运行以下命令,使用符号链接安装它,这样当您更改代码时,更改将自动对应用程序可用,而无需重新安装包:

$ cd falcon
$ pip install -e .

您可以通过切换到克隆的repo目录,然后运行pytest,手动测试对falcon框架的更改:

$ cd falcon
$ pip install -r requirements/tests
$ pytest tests

或者,要运行默认测试集:

$ pip install tox && tox

小技巧

也见 tox.ini 文件以获取可用环境的完整列表。

最后,要从源代码构建Falcon的文档,只需运行:

$ pip install tox && tox -e docs

创建文档后,您可以通过在浏览器中打开以下索引页来查看它们。在OS X上,简单的如下:

$ open docs/_build/html/index.html

或者在Linux上:

$ xdg-open docs/_build/html/index.html