Установка

PyPy

PyPy — это самый быстрый способ запуска вашего приложения Falcon. Однако обратите внимание, что в настоящее время поддерживается только выпуск PyPy 2.7.

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