Установка

PyPy

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

$ pip install falcon

CPython

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

Универсальный 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 и скомпилирует (т.е. преобразует с помощью Cython) фреймворк Falcon с помощью системного компилятора C.

$ pip install cython
$ pip install --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 всегда приветствуются! Также, пожалуйста, не забудьте поставить звезду проекту, если он вам нравится. :)

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

$ cd falcon
$ pip install .

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

$ cd falcon
$ pip install -e .

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

$ cd falcon
$ pip install -r tools/test-requires
$ 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