Первые шаги

Введение

Этот раздел описывает процесс создания проекта веб приложения на BlueBream. После изучения этого раздела, вы будете уметь:

• Устанавливать шаблон BlueBream проекта на основе PasteScript

• Создавать проект BlueBream приложения на базе созданного шаблона

• Запускать систему сборки (Buildout) и собирать приложение
• Запускать WSGI-совместимый веб сервер для работы приложения
• Запускать тесты и использовать оболочку для отладки (debug shell)
• Создавать приложения в стиле "Hello World"

Перед тем, как приступить, сделаем краткий обзор подразделов.

• Подготовка: – В этом подразделе обсуждается подгодовка, которую необходимо провести перед началом разработки BlueBream приложения.

• Установка: – Дает пользовательские инструкции по установке BlueBream.

• Создание простого проекта: – Этот подраздел объясняет пользователю, как создать простое веб приложение, используя шаблон проекта bluebream.
• Сборка приложения: – Этот подраздел объясняет, как собирать приложение используя Buildout.

• Основы использования: – Этот подраздел олбъясняет основы использования комманд BlueBream.

• Структура папок проекта: – Этот подраздел показывает структуру папок и описывает назначение каждого файла и директории.

В конце предоставляются несколько примеров в стиле "hello world".

Подготовка

Этот документ подразумевает, что пользователь уже установил Python 2.4, 2.5 или 2.6 и Distribute (или Setuptools). Если Distribute (или Setuptools) установлены, пользователь имеет возможность использовать команду easy_install, которая используется для установки пакета bluebream. Другой путь установить bluebream - использовать PIP, как замену easy_install, и который содержит некоторые улучшения. Одно из преимуществ в том, что вы получаете возможность деинсталляции пакетов.

Пользователь также имеет аозможность установить BlueBream в изолированной среде Python используя Virtualenv. Но virtualenv не обязателен для работы с приложением, потому что Buildout доступен изначально, как только создано приложение. Buildout - рекоммендуемый подход для создания повторяемой, изолированнрй рабочей среды. Buildout - декларативная, конфигурабельная система сборки созданная Джимом Фултоном.

Для работы с BlueBream рекоммендуется использовать Python собранный вручную. Пользователю необходимо установить компилятор языка C (gcc), а также иметь доступ по Интернет к !PyPI для произведения установки пакета bluebream, загрузкт сборщика, и сборки приложения с помощью Buildout. Доступ к Интернет не обязателен для сборки, если используется пакет zc.sourcerelease.

Установка

Если пользователь уже установил Distribute (или Setuptools), становится доступной комманда easy_install, которую можно использовать для утсановки BlueBream.

   1 # easy_install bluebream
   2 

или:

   1 $ sudo easy_install bluebream

Постарайтесь избегать запуска комманд easy_install от пользователя root или вместе c sudo для больших установок, так как это может привести к конфликтам с родной системой пакетов ОС. Установка шаблона bluebream таким способом допустима, потому что он не имеет много зависимостей.

Как уже упоминалось раньше, Интернет доступ к !PyPI необходим для произведения установки пакета bluebream. Если пользователь работает через прокси, он должен удостоверится в работоспособности утилит самостоятельно. На GNU/Linux платформах easy_install ищет переменную окружения с именем http_proxy. Пользователь может установить ее следующим образом:

   1 $ export http_proxy="http://username:password@PROXY-IP-ADDRESS:PORT"

Кроме пакета bluebream, easy_install также загрузит его зависимости. Вот их список:

• PasteScript

• PasteDeploy

• Paste

Установка шаблонного пакета bluebream - одноразовый процесс. Когда пакет проекта готов, пользователю больше не нужен шаблонный пакет bluebream, потому что тот пакет, который впоследствии пользователь создаст будет самозагружаемым.

Создание простого проекта

Пакет bluebream предоставляет шаблон проекта, который основан на шаблонах PasteScript. Когда BlueBream уже установлен, выполните комманду paster для создания структуры директорий проекта. Опция create команды paster отобразит мастер создания проекта в коммандной строке.

   1 $ paster create -t bluebream

Это действие запустит мастер установки, который будет спрашивать информацию о проекте. Пользователь может выбрать имя пакета и версию самостоятельно. Эту информацию также можно впоследствии изменить. Теперь пользователь получает работающее приложение с именем проекта, а так же яйцо с таким же именем. Название проекта может быть строкой с точками (dotted name), если пользователь хочет, чтобы его проект был частью пространства имен, при этом можно импользовать любое количество урвоней пространства. Проект можно назвать ‘sample’, ‘sample.main’ или ‘sample.app.main’ или даже сделать его еще более глубоким. Также будет создана необходимая структура директорий.

Вот скриншот примера создания проекта:

Имя проекта и другие параметры можно предоставить через аргументы в коммандной строке:

   1 $ paster create -t bluebream sampleproject

   1 $ paster create -t bluebream sampleproject version=0.1

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

• python_package – Name of the main Python package (possibly with namespaces)

• interpreter – Name of the custom Python interpreter

• version – Version (like 0.1)

• description – One-line description of the package

• long_description – Multi-line description (in reST)

• keywords – Space-separated keywords/tags

• author – Author name

• author_email – Author email

• url – URL of homepage

• license_name – License name

• zip_safe – True, if the package can be distributed as a .zip file otherwise False.