Руководство для разработчиков PyOCD

Разработчикам PyOCD рекомендуется настроить рабочую среду с помощью virtualenv. После клонирования кода вы можете настроить virtualenv и установить зависимости pyOCD для текущей платформы, следуя подробным шагам ниже.

Настройка

Установите необходимые инструменты, перечисленные ниже. Пропустите любой шаг, где уже существует совместимый инструмент.

• Установите Python. Рекомендуется установить как Python 3.7.0 или выше, так и Python 2.7.15 или выше, чтобы протестировать обе версии. Добавьте в PATH.
  • Обратите внимание, что на Windows 32-битный Python 2.7 должен быть установлен для правильной работы Python-enabled gdb и прохождения функционального теста test/gdb_test.py.
• Установите Git. Добавьте в PATH.
• Установите virtualenv в вашу глобальную установку Python, например: pip install virtualenv.
• Установите GNU Arm Embedded toolchain. Этот инструмент предоставляет arm-none-eabi-gdb, используемый для тестирования gdbserver. Добавьте в PATH.

Шаги

Шаг 1. Получите исходные коды и создайте виртуальную среду

$ git clone https://github.com/mbedmicro/pyOCD
$ cd pyOCD
$ virtualenv venv

Вы можете создать две виртуальные среды, для Python 2.7 и 3.x.

$ python2 -mvirtualenv venv2
$ python3 -mvirtualenv venv3

Шаг 2. Активируйте виртуальную среду

Активируйте ваш virtualenv и установите зависимости pyOCD для вашей платформы, выполнив следующие действия.

Linux или Mac:

$ source venv/bin/activate
$ pip install -r dev-requirements.txt

Windows:

$ venv\Scripts\activate
$ pip install -r dev-requirements.txt

Шаг 3. Разработка

Смотрите руководство по переносу (adding_new_targets.md) о том, как добавить новые устройства. Конечно, мы приветствуем все улучшения и изменения. Смотрите заявление участника (../CONTRIBUTING.md) для некоторых рекомендаций.

Шаг 4. Тестирование

Чтобы запустить модульные тесты, вы можете выполнить следующее.

$ pytest

Чтобы получить результаты покрытия кода, выполните следующие действия:

$ pytest --cov-report=html --cov=pyocd
$ open htmlcov/index.html

Также необходимо запустить автоматизированный набор тестов:

$ cd test
$ python ./automated_test.py

Шаг 5. Запрос на включение изменений

Как только вы будете удовлетворены изменениями и все автоматические тесты пройдут успешно, пожалуйста, создайте новый запрос на включение изменений (pull request) на GitHub, чтобы поделиться своей работой.

Запросы на включение изменений должны быть сделаны после того, как изменения будут перебазированы на Master (https://www.atlassian.com/git/tutorials/merging-vs-rebasing/workflow-walkthrough).