Установка

PyPy

PyPy — самый быстрый способ запуска вашего приложения Falcon. Поддерживаются как PyPy2.7, так и PyPy3.5, начиная с PyPy v5.10.

$ pip install falcon

Или, чтобы установить последнюю бета-версию или кандидатную версию релиза (если таковая имеется):

$ pip install --pre falcon

CPython

Falcon также полностью поддерживает CPython 2.7 и 3.5+.

Универсальные и manylinux wheel доступны на PyPI для фреймворка Falcon. Установка так же проста, как:

$ pip install falcon

Установка одного из предварительно скомпилированных Falcon wheel — отличный способ быстро начать работу. Однако при развертывании приложения в рабочей среде вы можете захотеть скомпилировать Falcon с помощью Cython самостоятельно, используя собственный инструмент целевой системы.

Следующие команды говорят pip установить Cython, а затем вызвать setup.py, который в свою очередь обнаружит наличие Cython и затем скомпилирует (иначе говоря, cythonize) фреймворк Falcon с помощью системного компилятора C.

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

Если вы хотите проверить, что Cython вызывается, просто передайте -v pip для вывода команд компиляции:

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

Установка в OS X

Для компиляции Cython необходимы Xcode Command Line Tools. Установите их с помощью этой команды:

$ 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 — сервер WSGI на чистом Python, с отличным качеством и приемлемой производительностью. К сожалению, Gunicorn все еще не работает под Windows, а для uWSGI требуется Cygwin. Waitress — хорошая альтернатива для Windows-разработчиков, которые хотят быстро начать работу с Falcon.

$ pip install [gunicorn|uwsgi|waitress]

Исходный код

Falcon размещен на GitHub, что упрощает просмотр, скачивание, создание форков и т. д. За pull request всегда рады! Также, пожалуйста, не забудьте поставить звезду проекту, если он вам нравится. :)

После клонирования репозитория или скачивания tarball с GitHub, вы можете установить Falcon так:

$ cd falcon
$ pip install .

Или, если вы хотите отредактировать код, сначала создайте форк основного репозитория, клонируйте форк на свой компьютер, а затем выполните следующее, чтобы установить его с помощью символической ссылки, так что при изменении кода изменения будут автоматически доступны вашему приложению без необходимости переустанавливать пакет:

$ cd falcon
$ pip install -e .

Вы можете вручную протестировать изменения в фреймворке Falcon, перейдя в каталог клонированного репозитория и запустив pytest:

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

Или, чтобы запустить стандартный набор тестов:

$ pip install tox && tox

Наконец, чтобы скомпилировать документацию Falcon из исходного кода, просто выполните:

$ pip install tox && tox -e docs

После компиляции документации вы можете просмотреть их, открыв следующую страницу индекса в вашем браузере. В OS X это так же просто, как:

$ open docs/_build/html/index.html

Или в Linux:

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