Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 3.58 KB

Настройка рабочего окружения

Скачивание репозитория

После первичной настройки Git сделай Fork репозитория и склонируй себе командой:

git clone https://github.com/<your name>/lambdaweb.git

или, если в системе установлен SSH ключ:

git clone [email protected]:<your name>/lambdaweb

Установка Python

На продакшене используется Python версии 3.4.3 . Скачать можно отсюда, но в большинстве популярных дистрибутивах (Ubuntu, Fedora) он присутствует по умолчанию и вызывается командой python3.
Вести разработку и тестировать локально можно и в более свежих версиях, например, 3.5 или 3.6 , но учитывать обратную совместимость (например, новые способы форматирования литералов и вот такие 1_000_000 числа, добавленные в 3.6, на рабочем сервере не заведутся).

Создание virtualenv

Linux

# устанавливаем virtualenv
sudo pip3 install virtualenv virtualenvwrapper

# указываем на интерпретатор нужной версии и скрипт для удобной работы
echo "export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3" >> ~/.bashrc
echo "source /usr/local/bin/virtualenvwrapper.sh" >> ~/.bashrc

# указываем на директорию, в которой будем хранить окружение
export WORKON_HOME=/path/to/directory

# создаем новое окружение
mkvirtualenv lambdaweb

Windows | MacOS | Linux (easy way)

Установите Pycharm ✨

Включение линтеров

Наш проект придерживается правил оформления кода pep8, поэтому во избежание всякого - используем flake8 в качестве линтера. Допускаем превышение длины строки более 79 символов, больше -- ни-ни 😠

# устанавливаем
$ pip install flake8

Для запуска использовать конфигурационный файл tox.ini, находящийся в корне репозитория:

$ flake8 --config=tox.ini .

Правильным шагом будет интеграция flake8 с Pycharm и Git. Сделать это можно по инструкции, описанной тут .

GitFlow

Ветвить проекты надо с умом. Вся разработка в нашем проекте идет только в ветке develop и соответствующих от нее ответвлениях. Для удобства работы необходимо установить git flow. Установка и использование описаны тут

Ввиду скорой упаковки проект в docker-контейнер, эта инструкция может сильно измениться.