epcore

epcore – это общий набор ключевых модулей, на базе которых строится различное ПО, работающее с сигнатурными анализаторами EyePoint.

Все новые модули нужно делать по образцу существующих в этом проекте. Нужно соблюдать сходство именований и архитектуры папок.

Про ветки

• Ветка dev-0.1 - основная.
• Ветка t-astra - для ОС Astra Linux, она наследует ветку dev-0.1. В ветке t-astra не поддерживается измеритель ASA.
• Ветка dev-0.2 наследует ветку dev-0.1. В ветке dev-0.2 добавлена поддержка кнопок на измерителях IVMeasurerIVM.

Все общие изменения нужно вносить сначала в ветку dev-0.1, а потом сливать в t-astra и dev-0.2.

Тесты в Windows

Перейдите в папку scripts и запустите скрипт testall.bat.

Тесты в Linux

Перейдите в папку scripts и запустите скрипт testall.sh:

bash testall.sh

Релиз

Чтобы выпустить релиз, нужно:

1. Перейти в ветку dev-V.V.
2. Запустить тесты и убедиться, что все тесты прошли успешно.
3. Проверить, что в файле setup.py в поле version указана версия, которая будет выпущена, например X.X.X.
4. На последний коммит в ветке dev-V.V повесить тег vX.X.X.
5. Увеличить номер версии в файле setup.py и зафиксировать изменение в репозитории с комментарием "Version increment".
6. Если релиз выпускается для ветки dev-0.1:
   1. Слить ветку dev-0.1 в ветку t-astra.
   2. Перейти в ветку t-astra.
   3. Проверить, что в файле setup.py в поле version указана версия, которая будет выпущена, например X.X.X-astra.
   4. На последний коммит в ветке t-astra повесить тег vX.X.X-astra.
   5. Увеличить номер версии в файле setup.py и зафиксировать изменение в репозитории с комментарием "Version increment".

Прочие инструкции

Запуск теста для одного модуля

python -m unittest discover epcore/filemanager

Запуск примера работы с модулем

python -m epcore.filemanager

Добавление пакетной зависимости (например: numpy, simpleaudio, etc)

В файле setup.py укажите требуемый пакет, например:

    install_requires=[
        "numpy",  # for pin module
        "simpleaudio"  # for sound module
    ],

Добавление бинарной зависимости

В файле setup.py укажите требуемый файл, например:

    package_data={
        'epcore.sound': ['sound/foo.so']  # for sound module
    }