Обновленный чеклист запуска нового проекта (уровень 3)

Чек-лист проекта (уровень 3)

Этот очередной урок-напоминание. Обратите внимание на шаги, которые необходимо сделать, когда начинаете новый Python проект. И на то как они поменялись с начала курса.

Проверьте все ли необходимые действия вы сделал:

[ ] Правильный путь к директории проекта. Директории содержат только латинские буквы и не содержат лишних пробелов
[ ] Создать виртуальное окружение python -m venv venv
[ ] Подготовить git репозиторий. Вы можете получить инструкцию на сайте Github или Gitlab. Минимальный необходимый шаг git init
[ ] Добавьте .gitignore, можно взять за основу Python .gitignore

Управление зависимостями:

[ ] Добавьте необходимые пакеты с помощью pip install <имя>
[ ] Добавьте файл requirements.txt в котором перечислите необходимые зависимости
[ ] Добавьте файл с зависимостями необходимыми для разработки, например dev-requirements.txt

Управление качеством кода:

[ ] Добавьте в проект black pip install black или установите его глобально
[ ] Настройте работу pylint чтобы автоматически проверять качество кода

Инфраструктура разработки:

[ ] Добавьте Makefile с минимум двумя таргетами для удобства запуска проекта в будущем. make setup для развертки окружения и make run для запуска
[ ] Добавьте make lint который будет проверять качество кода
[ ] Добавьте файл, который будет запускать код с if __name__ == "main"

Публикация кода:

[ ] Добавьте директорию docs в которой разместите текстовую документацию по проекту
[ ] Прежде чем публиковать код добавьте файл с лицензией LICENSE
[ ] Опубликуйте код на внешнем репозитории, например на Github (обратите внимание, на права доступа)