HW 4. Functions 2

This is the repo for the fourth homework of the BI Python 2023 course

Homework description

На прошлой неделе вы делали утилиту для работы с последовательностями нуклеиновых кислот (с весьма строгим ТЗ). Пришло время для чего-то более самостоятельного.

Основное задание

Напишите утилиту для работы с последовательностями белков. Там должно быть минимум 5 различных операций, должна быть какая-то точка входа через которую пользователь будет всё это дело использовать. На этом, по сути, всё. Всё целиком зависит от вашей фантазии и креативности. Можете опираться на ДЗ №2 и №3.

Самая главная часть задания - это файл README.md. Сделайте краткое введение, напишите описание тула, приведите документацию по использованию со списком аргументов. Добавьте примеры использования. Возможно, вы захотите сделать секцию Troubleshooting. Почему это нужно? В этот раз проверяющий не будет знать того, как должен работать ваш тул. Это ваш авторский код. Даже самая прекрасная функциональность, не будучи отраженной в README, скорее всего останется незамеченной. README - это ваш способ познакомить пользователя с тулом, показать всё лучше и обосновать, почему именно ваша команда должна получить наивысший балл.

Есть люди которые, любят писать документации, а есть те - кто не любит. Найдите в вашей команде того, кто любит. И в будущем в своих рабочих проектах всегда держите рядом такого человек (или будьте им).

Примеры некоторых README, которыми можно вдохновляться:

• MetaFX, тул Артёма Иванова. Там еще и wiki крутое.
• samovar
• MetaGEM
• Pharokka

Типовые секции, на которые стоит обратить внимание: Title, Overview, Usage, Options, Examples, Troubleshooting, Contacts.

Tехническое требование к заданию.

Это задание будет выполняться в командах по 3 человека. Каждый из членов команды должен внести как минимум 2 функции. Каждое внесение функции должно сопровождаться коммитом с осмысленным описанием коммита. Ниже приведена последовательность действий для успешного выполнения задания (аналогично ДЗ №2):

1. Посмотрите состав своей команды здесь (ССЫЛКА).
2. Тимлид делает форк данного репозитория. В форке создает ветку HW4_<surname>, в ветке создает папку HW4_<surname>, в этой папке вы всё делаете.
3. Члены команды могут либо делать свои форки, либо работать в репозитории тимлида в качестве колабораторов ("contributors"). В любом случае делаете клоны => пишите код локально => пушите.
4. В конце тимлид делайет pull-request из HW4_<surname> своего репозитория в main этого.

А также:

• Сопроводите программу лучшим README.md файлом в вашей жизни (на английском языке).
• В этом ДЗ проблемы с качеством кода (нейминги, пустые строки, анноатции типов, док.стринги, пробелы) могут привести к снижению балла. Воспользуйтесь линтерами чтобы себя обезопасить. IDE по типу PyCharm или VSCode имеют фунцонал по авто-исправлению многих проблем такого рода.

Автотестов на GitHub в этом ДЗ нет, но вы можете прогнать линтеры на качество кода локально (как в ДЗ №3, подробнее читайте тут).

• Программа должна сохранять регистр символов.
• Программа должна работать только с последовательностями белков.
• Запрещается использование сторонних модулей.

Форма сдачи

Прикрепите ссылку на pull-request тимлида в Google Class (можете сделать от лица каждого члена команды, но это не обязательно).

Pазбалловка

• За каждую из 5 операций - максимум 1.5 балла
• За README - максимум 2.5 балла
• Если вы не внесли как минимум 2 функции от себя, вы получаете 0 баллов (на баллы остальных членов команды это не влияет).
• За фото созвона в README можно получить 0.2 доп. балла (но не более 10 баллов суммарно)

Предполагаемый учебный результат

Это задание позволит вам проявить креативность и учиться быть не только кодером, но и автором. Также это задание поможет окончательно закрепить материал по функциям который мы прошли.

Удачи! ✨✨