Программирование

GitHub API со сценариями Python и PowerShell

Использование GitHub API со сценариями Python и PowerShell для создания и управления репозиториями

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

В этой статье я покажу вам, как использовать GitHub API для разработки классного приложения на Python для создания и управления репозиториями GitHub.

Для создания графического интерфейса мы можем использовать модуль Python Tkinter. Давайте протестируем нашу настройку API, используя следующую команду. Все данные отправляются и принимаются в формате JSON.

curl https://api.github.com/zen

Ответом будет случайный выбор из философии дизайна GitHub.

Создать новый репозиторий

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

  • Проверка имени пользователя GitHub - можно узнать, существует ли учетная запись GitHub с данным именем пользователя или нет.

Нам нужно использовать указанную ниже конечную точку.

https://api.github.com/users/GitHub_Username

Если пользователь существует, он возвращает код состояния «200». И мы можем увидеть результат, как показано ниже.

Теперь это можно использовать для создания функции, проверяющей, существует ли пользователь.

Если имя пользователя не существует, мы можем попросить пользователя создать учетную запись GitHub. Если он существует, нам нужно проверить, существует ли репозиторий.

  • Проверьте, существует ли репозиторий

Приведенная ниже конечная точка вернет список репозиториев для данного имени пользователя в формате JSON.

curl https://api.github.com/users/GitHub_UserName/repos

Ответ будет примерно таким

Чтобы создать новый репозиторий, нам нужно убедиться, что имя репозитория, введенное пользователем, не существует.

Если ответ не возвращает код состояния «200», это означает, что публичный репозиторий для этой учетной записи GitHub не существует. Итак, мы готовы приступить к созданию репозитория.

  • Описание - необязательный параметр. Мы можем добавить описание в наш репозиторий GitHub через API.

  • Путь к репозиторию - чтобы отправить (загрузить) файлы в репозиторий, мы можем запросить у пользователя путь к каталогу. Это может быть необязательный параметр, по умолчанию мы можем взять путь к текущему каталогу

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

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

Теперь мы можем выполнить скрипт на Python, как показано ниже,

Вы можете найти полный код скрипта PowerShell здесь.

Давайте попробуем на примере,

После отправки деталей нам нужно ввести пароль для этой учетной записи GitHub.

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

Мы также можем создать репозиторий с помощью следующей команды:

curl -u GitHub_UserName https://api.github.com/user/repos -d "{\"name\":\"Test-Repo\",\"description\":\"A Sample Description\"}"

Мы также можем использовать API GitHub в наших веб-приложениях или приложениях для Android. В корневую конечную точку можно передавать различные параметры, чтобы получить определенные ответы, необходимые для нашего текущего приложения. Более подробную информацию можно найти здесь.

Чтобы загрузить все приложение на Python, нажмите здесь.

Полный код можно найти на GitHub здесь.

Заключение

Мы увидели, как использовать GitHub API в наших приложениях для создания репозиториев и управления ими. Увидимся снова с более интересными темами. А пока оставайся в безопасности и оставайся дома.

Если вы хотите связаться, свяжитесь со мной в LinkedIn.