Установка

PyPy

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

$ pip install falcon

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

$ pip install --pre falcon

CPython

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

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

$ pip install falcon

Если доступен ujson, Falcon будет использовать его для ускорения сериализации/десериализации данных, сериализации ошибок и парсинга параметров запроса. Обратите внимание, что ujson на PyPy может быть медленнее стандартного модуля json из-за накладных расходов ctypes, поэтому мы рекомендуем использовать ujson только с развертываниями CPython:

$ pip install ujson

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

Следующие команды говорят pip установить Cython, а затем вызвать setup.py Falcon, который в свою очередь определит наличие Cython и затем скомпилирует (то есть скомпилирует с помощью Cython) фреймворк 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 обрабатывает неизвестные параметры командной строки как ошибки; это может вызвать проблемы, например, под Python 2.6:

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 зависит от six и python-mimeparse. python-mimeparse — это более поддерживаемый форк проекта с аналогичным названием mimeparse. Обычно правильный пакет будет выбран механизмом setup.py Falcon. Однако, если вы используете альтернативную стратегию управления зависимостями, убедитесь, что установили правильный пакет, чтобы избежать ошибок.

WSGI Сервер

Falcon использует WSGI, поэтому для обслуживания приложения Falcon вам потребуется WSGI-сервер. Gunicorn и uWSGI — одни из наиболее популярных, но подойдет любой, способный загрузить WSGI-приложение.

Все разработчики Windows могут использовать сервер WSGI Waitress производственного качества, написанный на чистом Python, с очень приемлемой производительностью. К сожалению, Gunicorn все еще не работает в Windows, а uWSGI требует установленной Cygwin в Windows. Waitress может быть хорошей альтернативой для пользователей Windows, если они хотят быстро начать работу с Falcon.

$ pip install [gunicorn|uwsgi|waitress]

Исходный код

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

После клонирования репозитория или загрузки 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