Працюємо з 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 у вашому проекті.

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