GitHub/GitHub_Get_files_changed_on_pull_request.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "4442eb20-2e95-4e4d-b90d-2ccf6ad4d78a",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "<img width=\"8%\" alt=\"GitHub.png\" src=\"https://raw.githubusercontent.com/jupyter-naas/awesome-notebooks/master/.github/assets/logos/GitHub.png\" style=\"border-radius: 15%\">"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f16604c8-5bce-498d-9a94-01d578cf96ba",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "# GitHub - Get files changed on pull request\n",
    "<a href=\"https://bit.ly/3JyWIk6\">Give Feedback</a> | <a href=\"https://github.com/jupyter-naas/awesome-notebooks/issues/new?assignees=&labels=bug&template=bug_report.md&title=GitHub+-+Get+files+changed+on+pull+request:+Error+short+description\">Bug report</a>"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "c7babaa8-1d36-4b49-b974-7380abd776af",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Tags:** #github #pullrequest #files #api #python #git"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f1fe7ccc-7ffb-4248-8b20-16a29d4c581c",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Author:** [Florent Ravenel](https://www.linkedin.com/in/florent-ravenel/)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4e34cdc8-78b0-4219-828e-0fde03b5521c",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Last update:** 2023-04-12 (Created: 2023-03-09)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "99365514-8f30-4773-aeff-244cc6509f90",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Description:** This notebook get the list of files changed on a pull request using the GitHub API. Files changed could be 'added', 'renamed' or 'removed'."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "53f735d5-dab8-440f-b3fc-343e8e168c1e",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**References:**\n",
    "- [GitHub API Documentation](https://developer.github.com/v3/)\n",
    "- [GitHub Pull Request API Documentation](https://developer.github.com/v3/pulls/)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "5830fcf2-f9df-43fb-bc69-f74a79ae88ff",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Input"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1d076bb7-7a29-4390-9ae5-011f19c96a12",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Import libraries"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "88bc37ba-d0da-443d-8458-d22db8d3255f",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "import requests\n",
    "import naas\n",
    "from pprint import pprint"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "11357767-c7d8-4514-9bb1-99ba2ab16a80",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Setup Variables\n",
    "- `token`: Create your personal access token [here](https://github.com/settings/tokens)\n",
    "- `owner`: owner of the repository\n",
    "- `repo`: name of the repository\n",
    "- `pull_number`: number of the pull request"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "22bf9b63-7469-4459-8802-4a1d47b038a6",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "token = naas.secret.get(\"GITHUB_TOKEN\") or \"GITHUB_TOKEN\"\n",
    "owner = \"jupyter-naas\"\n",
    "repo = \"awesome-notebooks\"\n",
    "pull_number = 1496"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4f27a92d-3617-480c-a7e4-3294dc164317",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Model"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "83498d79-99bb-4a34-bb67-3dcc7e2e0c76",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Get files changed on pull request"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9a684b02-b1f1-4d60-801a-5fefdadd14dc",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "This function will use the GitHub API to get the list of files changed on a pull request."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "5df613ec-6d63-4e27-91bf-64d0b535de0b",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "def get_files_changed_on_pull_request(owner, repo, pull_number):\n",
    "    url = f\"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/files\"\n",
    "    response = requests.get(url)\n",
    "    return response.json()\n",
    "\n",
    "files_changed = get_files_changed_on_pull_request(owner, repo, pull_number)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "228394cf-7dc6-4540-bfc2-2be61d66948f",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Output"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8bc72398-4f52-4bc4-b0ea-92840002d994",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Display result"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e9680af6-e21a-45e9-a826-50aca749c0a9",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "for file in files_changed:\n",
    "    filename = file[\"filename\"]\n",
    "    status = file[\"status\"]\n",
    "    print(f\"{filename}: {status}\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.6"
  },
  "naas": {
   "notebook_id": "c8b1218b10d5fedf3def66d9c7037ad6ee1b3b7f9bdb949ea73cce5d41dcf544",
   "notebook_path": "GitHub/GitHub_Get_files_changed_on_pull_request.ipynb"
  },
  "papermill": {
   "default_parameters": {},
   "environment_variables": {},
   "parameters": {},
   "version": "2.4.0"
  },
  "widgets": {
   "application/vnd.jupyter.widget-state+json": {
    "state": {},
    "version_major": 2,
    "version_minor": 0
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}