Работаем с GitHub из PyCharm

10.1 Клонирование репозитория

Помните, я рассказывал вам про 3 места хранения файлов? Напомню: бывает удаленный репозиторий, локальный репозиторий и рабочая директория.

Так вот, сейчас вам нужно будет клонировать ваш удаленный репозиторий (который вы создали на GitHub) в ваш локальный репозиторий (тот, что на вашем компьютере).

Поэтому запускайте PyCharm и начинаем…

Шаг 1. Закройте проект если он открыт. И нажмите Clone Repository

Шаг 2. Укажите url вашего удаленного репозитория, который вы хотите клонировать на ваш компьютер.

Такой способ полезен, если вы клонируйте чей-то репозиторий.

Если вы клонируйте свой, то будет проще просто залогиниться на GitHub через PyCharm.

Выбирите проект и жмите Clone

Шаг 3. Никому нельзя доверять. Даже себе.

PyCharm предупреждает, чтобы не запускали код из неизвестных репозиториев. Поскольку это ваш собственный репозиторий, то ставим галочку "доверять".

Шаг 4. Если у вас Windows, стандартный антивирус предупредит, что появились какие-то неизвестные ему файлы. Антивирусы вообще не любят неизвестные ему программы.

НО! Мы собираемся эти самые программы создавать, поэтому говорим IDE сказать антивирусу, чтобы он не блокировал ваши будущие программы. Кликайте по кнопке «Automatically», затем — «YES».

10.2 Первый коммит

Если вы клонировали свежесозданный репозиторий, он будет содержать только один файл — README.md

Шаг 1. Откройте файл README.md.

Важно! Разрешение md означает Markdown – это такой примитивный формат стилизации текстовых файлов. Вы можете посмотреть, как он работает, кликнув по кнопке в правом верхнем углу.

Поменяйте этот файл, как вам захочется: можете написать любое приветственное сообщение или описание репозитория...

Шаг 2. После того, как вы внесли изменения в файл, PyCharm начал отображать его синим цветов в дереве файлов слева. Синим помечены все измененные файлы, если изменения в вашей рабочей директории еще не внесены в ваш локальный репозиторий.

Шаг 3. Коммит.

После того, как вы внесли в файл или файлы все планируемые изменения (и убедились в их правильности), нужно залить их в ваш локальный git-репозиторий. Пока что они находятся только в вашей рабочей папке.

Для этого вам нужно кликнуть по кнопке Commit и отметить все файлы, изменения которых вы хотите внести в локальный репозиторий и добавьте комментарий, описывающий ваши изменения.:

Шаг 4. И нажмите на кнопку «Commit».

Шаг 5. Проверка.

Переключаетесь в ваш проект и проверяете цвет файлов: если файлы перестали светиться синим, значит все изменения вашей рабочей директории были успешно внесены в ваш локальный репозиторий.

10.3 Работа с файлами

Шаг 1. Давайте создадим файл в PyCharm.

Мы же пишем код на Python — пусть это будет файл main.py

Шаг 2. Добавляем файл в локальный репозиторий.

Как только PyCharm увидел, что вы создали файл, он тут же предложил добавить его в ваш локальный репозиторий. PyCharm отслеживает изменения только тех файлов в вашей рабочей директории, которые уже находятся в вашем локальном репозитории. Они и только они будут помечены синим цветом.

Если файл есть в вашей рабочей директории, но в локальном репозитории его нет, он помечается красным, как на картинке ниже:

В принципе вы всегда можете нажимать Add, но давайте в этот раз нажмем Cancel и потом добавим файл вручную. Чтобы вы запомнили, как это делать.

Шаг 3. Пишем в файле ваш любимый код.

Я, например, написал: print("first commit")

Шаг 4. Теперь давайте добавим наш файл main.py в локальный репозиторий.

Просто кликните в любом месте файла правой кнопкой мышки и выберите Git -> Add File

Если все прошло успешно, добавленный файл будет светиться зеленым.

Шаг 5. Дальше коммитим файл по старой схеме:

10.4 Первый push

Теперь нам нужно залить наши изменения в локальном репозитории в удаленный репозиторий на GitHub. Когда несколько программистов работают над одним проектом, они таким способом синхронизируют свои изменения кода.

Шаг 1. Кликаем по кнопке Push.

На самом деле это сделать очень легко: вам просто нужно воспользоваться кнопкой Push в верхнем меню IDE:

Шаг 2. Подтверждаем внесенные коммиты.

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

Шаг 3. Проверяем.

Если все прошло успешно, вы увидите сообщения такого плана:

Шаг 4. А теперь открывайте ваш GitHub-репозиторий и проверяйте:

Магия технологий!

10.5 Использование .gitignore-файлов

Если вы добавили в ваш проект какие-то служебные файлы и не хотите, чтобы они случайно попали в репозиторий, можете добавить их в исключения. Для этого есть файл с именем .gitignore. Это очень удобно, когда в проекте есть файлы, которые не нужно хранить в системе контроля версий (например, временные файлы, логи, пароли).

Шаг 1. Для начала создайте файл в каталоге проекта, который хотите игнорировать. Например, .txt файл с любым именем. После создания файла нажмите Cancel.

Шаг 2. Щелкните правой кнопкой мыши по созданому файлу hacky_fix_that_somehow_works.txt в окне "Project". Перейдите к Git --> Add to .gitignore --> Add to .gitignore. Эта опция добавляет выбранный файл в файл .gitignore в корне вашего проекта.

Шаг 3. Создайте .gitignore в вашем проекте. При создании репозитория мы не создавали файл .gitignore

PyCharm автоматически добавит имя файла hacky_fix_that_somehow_works.txt в ваш файл .gitignore.

После добавления файлов в .gitignore они будут отображаться коричневым цветом. При попытке зафиксировать изменения эти файлы будут проигнорированы.

Файл .gitignore влияет только на файлы, которые еще не были закоммичены в репозитории Git. Если файл уже был закоммичен, то для его игнорирования нужно сначала удалить его из репозитория.

Не забудьте закоммитить сам файл .gitignore в репозитории Git и отправить изменения на GitHub, чтобы все участники проекта использовали одинаковые правила игнорирования файлов.

Исключение локальных файлов .git/info/exclude

Помимо файла .gitignore , который используется для исключения файлов для всех пользователей проекта, Git предоставляет возможность создавать локальные правила игнорирования .git/info/exclude, которые не будут закоммичены в репозитории и будут действовать только для вашей локальной копии проекта.

Это может быть полезно, например, для игнорирования файлов, созданных вашим IDE, которые не должны попадать в систему контроля версий.

Важно! Локальные правила игнорирования действуют только для вашей локальной копии репозитория.

Правила для .gitignore

В файле .gitignore указываются шаблоны имен файлов и папок, которые git должен игнорировать.

Пустые строки игнорируются. Чтобы добавить комментарий, начните строку с символа #.

Шаблоны:

• * - заменяет любое количество любых символов. Например, *.log игнорирует все файлы с расширением .log.
• ? - заменяет один любой символ. Например, temp?.txt игнорирует файлы temp1.txt, temp2.txt и т.д.
• [] - указывает диапазон символов. Например, [abc] соответствует любому из символов a, b или c.
• ! - исключает файлы, соответствующие шаблону. Например, !important.txt будет отслеживать файл important.txt, даже если есть правило *.txt.
• / - в начале шаблона указывает на корень репозитория. /temp/ игнорирует папку temp в корне репозитория.
• ** - соответствует любому количеству вложенных папок. Например, **/temp игнорирует папки temp на любом уровне вложенности.

Пример файла

# Байткод
*.pyc
**/__pycache__/
*.pyo
*.pyd

# Файлы с паролями и секретами
.env
credentials.json

# Временные файлы
*.tmp
*.swp
*~

# Логи
logs/*
*.log

# Папки, создаваемые PyCharm
.idea/
*.iml

# Папки для тестов
tests/
test/

# Виртуальные окружения
venv/
env/

# Файлы, создаваемые при упаковке проекта
dist/
build/
*.egg-info/

Готовые шаблоны

1. Коллекция .gitignore для разных языков программирования и сред разработки: https://github.com/github/gitignore
2. gitignore.io - веб-сервис, призванный помочь создавать файлы .gitignore