Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-02-26

1 Между первым и последующими проектами на Хекслет в профессии "<a>Python-разработчик</a>" может пройти некоторое время, месяцев шесть, как в моем случае. И за это время многие навыки и знания позабылись. Особенно не хватило четкого знания, что делать перед началом проекта с подключением к GitHub, с подключением и настройкой Poetry, что такое Flake8 и где взять шильдик Code Climate. И не хватило мне компактной шпаргалки. Пришлось собирать разрозненные сведения по курсам и статьям Хекслета и на просторах интернета.

2 Подключение к GitHub:

3 <ul><li>Создание репозитория на GitHub и подключение к нему.</li>

4 </ul><ol><li>Создать новый репозиторий по ссылке<a>github.com/new</a>. Запомнить/скопировать <ИМЯ РЕПОЗИТОРИЯ>. Не ставить галочку на создание README файла. Репозиторий должен быть пуст при создании.Примечание:это если вы уже зарегистрированы на GitHub и у вас заведены SSH-ключи. Если не зарегистрированы, то регистрируйтесь и заводите SSH-ключи. Про ключи написано тут-<a>https://github.com/Hexlet/ru-instructions/blob/main/git.md</a>.</li>

5 <li>Выбираем или создаем папку на компьютере. Как вариант - командой mkdir. Если планируется создавать в проекте окружение с использованием Poetry, то папку можно создать соответствующей командой poetry new <ИМЯ ПАПКИ>. И там уже будет развернута структура Poetry.</li>

6 <li>Во вновь созданной на компьютере папке для репозитория заводим Git командой git init.</li>

7 <li>Подключаем локальныйGitкGitHub. В командной строке выполнить команду git remote add origin https://github.com/<ИМЯ ХРАНИЛИЩА НА ГИТХАБЕ>/<ИМЯ РЕПОЗИТОРИЯ>.git. В моем случае команда целиком будет выглядеть так: git remote add origin https://github.com/AntonTyurin87/rep_2.git.</li>

8 <li>Создаем README файл на компьютере в папке для репозитория. Как вариант командой echo "# <ИМЯ ПАПКИ> >> README.md.</li>

9 <li>Добавляем README файл в Git в созданной папке на ПК git add.</li>

10 <li>Создаем коммит README файла в репозитории на ПК командой git commit -m.</li>

11 <li>Запускаем обнуление содержимого репозитория на GitHub командой git push.</li>

12 </ol>Проще говоря:Создал репозиторий на GitHub->Создал папку под репозиторий на ПК->Инициализировал Git в созданной папке на ПК->Создал первый README файл->Добавил READMY файл в репозиторий на ПК->Сделал коммит README файла в репозитории на ПК->Сделал PUSH README файла в репозиторий на GitHub.

13 Список команд в моем случае:

14 mkdir rep_2 cd rep_2 git init git remote add origin https://github.com/AntonTyurin87/rep_2.git echo "# rep_2" >> README.md git add README.md git commit -m "first commit" git push

15 Poetry:

16 Установка и работа с Poetry:

17 <ul><li>Более подробно и развернуто описано<a>тут</a>. Еще очень неплохо написано<a>тут</a>.</li>

18 </ul><ol><li>Устанавливаем Poetry не как обычную программу через pip install, а через команду, выбранную из текста<a>по ссылке</a>. В зависимости от ОС и среды на которую ставим.</li>

19 <li>Создаем папку для проекта командой poetry new <ИМЯ ПАПКИ>.</li>

20 <li>Настраиваем содержимое pyproject.toml. По нему Poetry и работает, как по инструкции.</li>

21 <li>Инициализируем виртуальное окружение командой poetry install.</li>

22 <li>Пакеты, которые нужны нам для работы, добавляем в список зависимостей командой poetry add <ИМЯ ПАКЕТА> после установки пакета. Информация о новом пакете появится в pyproject.toml.</li>

23 <li>Работу с Poetry более глубоко можно изучить<a>тут</a>.</li>

24 </ol>Создание Makefile:

25 При работе с проектом придется по несколько раз использовать множество длинных команд. Для упрощения ситуации прямо в корне папки проекта можно создать Makefile и в нем описать все необходимые команды, создав для них более короткий вызов. Подробнее о Makefile<a>тут</a>.

26 Flake8:

27 <ul><li>Это такой линтер, который помогает поддерживать читаемость и аккуратность кода. В Хекслете о нем писали<a>тут</a>. Документация на Flake8 -<a>тут</a>.</li>

28 </ul><ol><li>Если у вас уже стоит Poetry, то устанавливаем Flake8 командой poetry add --group=dev flake8. Без Poetry командой pip install flake8.</li>

29 <li>Можно прогонять через линтер как отдельные файлы командой flake8 <ИМЯ ФАЙЛА>, так и целые папки с файлами командой flake8 <ИМЯ ПАПКИ>.</li>

30 <li>Для Flake8 можно и нужно создать файл конфигурации setup.cfg и положить его в корень папки проекта. Вот<a>пример</a>такого файла конфигурации.</li>

31 </ol>Code Climate:

32 Еще есть такая штука, которая помогает команде программистов писать чистый код - Code Climate. Работает прямо с проектным кодом на GitHub и выдает ценные рекомендации и предупреждения. Подробно о том, как подключить к репозиторию, описано<a>тут</a>.