Домашняя работа № 1 (8 p.)
В качестве домашнего проекта мы напишем небольшую SCADA — controls-py. В этом задании вам предстоит развернуть рабочее окружение для вашего домашнего проекта.
(1 p.) Создайте git репозиторий для вашего проекта в gitea (зарегистрироваться можно через phystech.edu или Github аккаунт). Для этого форкните существующий репозиторий https://git.sciprog.center/Advanced_Python/advanced-python-homework-2023.
Задание повышенной сложности: если вы хотите глубже познакомиться с git, создайте пустой репозиторий и вытяните в него изменения из исходного репозитория.
(2 p.) Создайте python package
controls
and project file (pyproject.toml
orsetup.py
). Заполните информацию о проекте в project file.(1 p.) Создайте лицензию для проекта
(2 p.) Разверните виртуальное окружение на ваш выбор. Добавьте конфигурационный файл используемый при создании виртуального окружения и напишите в
README.md
последовательность команд для создания виртуального окружения. При создании виртуального окружения в него должны быть установленны следующие зависимости: Sphinx, Pylint, MyPy. Обратите внимание, что это окружения для разработки, указанные пакеты не должны быть основными зависимостями в project file и не должны устанавливаться при установке проекта.(1 p.) В файле
controls/__init__.py
создайте doсstring уровня пакета, в docstring тезисно опишите концепцию SCADA системы и какие возможности она должна предоставлять.(1 p.) Создайте sphinx-документацию для вашего проекта. Используя расширения sphinx автоматически сгенерируйте документацию из doсstrings пакета
controls
. Добавьте в README.md раздел с командами для генерации документации.