GitHub/GitHub_Get_commits_ranking_from_repository.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "b96a1e6d-e18e-4b90-9192-2aa111d694a2",
   "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": "1e0b104c-3f5c-4557-810c-510ad5c01aed",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "# GitHub - Get commits ranking from repository\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+commits+ranking+from+repository:+Error+short+description\">Bug report</a>"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "62bb926c-e38e-45fe-82fb-46ee85a7c33e",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Tags:** #github #repos #commits #stats #naas_drivers #plotly #linechart #operations #analytics #dataframe #html"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "bed3a749-ba5e-405f-a93b-696e583bb499",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Author:** [Varsha Kumar](https://www.linkedin.com/in/varsha-kumar-590466305/)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "259eb680-400b-4421-850e-4068b72ee0ea",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "**Last update:** 2024-06-12 (Created: 2022-03-18)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "naas-description",
   "metadata": {
    "papermill": {},
    "tags": [
     "description"
    ]
   },
   "source": [
    "**Description:** This notebook provides a way to view the commit rankings of a github repository."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3699bd74-3eba-4ebd-91a3-12ee02ddeb63",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Input"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "e802bdc0-6a85-4dac-8ef9-bba364e5d8c6",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "import pandas as pd\n",
    "import plotly.express as px\n",
    "from naas_drivers import github\n",
    "import naas_python as naas"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7fc73352-c674-4e46-8e3c-3afd17a59672",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Setup variables\n",
    "- `github_token`: personal token creates\n",
    "- `github_url`: link to the chosen github repo"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "fa40b6d3-867e-4361-92c8-4161abaa945f",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "github_token = naas.secret.get(\"GITHUB_TOKEN\").value\n",
    "repo_url = \"https://github.com/jupyter-naas/awesome-notebooks\""
   ]
  },
  {
   "cell_type": "markdown",
   "id": "0f2b7704-60e7-4e97-a1f9-b09779e7130a",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Model"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "bb7f0cb3-dfe6-4031-8c10-77d1610184fd",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2022-01-27T15:20:01.862544Z",
     "iopub.status.busy": "2022-01-27T15:20:01.862252Z",
     "iopub.status.idle": "2022-01-27T15:20:01.865361Z",
     "shell.execute_reply": "2022-01-27T15:20:01.864765Z",
     "shell.execute_reply.started": "2022-01-27T15:20:01.862513Z"
    },
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Get commits from repository url"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "334fee0f-2c06-41b0-b54c-56f78e2ec4f2",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "commits = github.connect(github_token).repos.get_commits(repo_url)\n",
    "commits"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f4087b7c-0347-45ee-95c4-b547f24b1bc2",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "## Output"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "caa405e0-b6ec-4812-9f0d-8849bebfa208",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Display result on a table"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "abdaa146-46e5-4031-99ac-2bc61774bf3e",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "def get_commits(df):\n",
    "    # Exclude Github commits\n",
    "    df = df[(df.COMMITTER_EMAIL.str[-10:] != \"github.com\")]\n",
    "\n",
    "    # Groupby and count\n",
    "    df = df.groupby([\"AUTHOR_NAME\"], as_index=False).agg({\"ID\": \"count\"})\n",
    "\n",
    "    # Cleaning\n",
    "    df = df.rename(columns={\"ID\": \"NB_COMMITS\"})\n",
    "    return df.sort_values(by=\"NB_COMMITS\", ascending=False).reset_index(drop=True)\n",
    "\n",
    "\n",
    "df = get_commits(commits)\n",
    "df"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e94d4a6d-4b81-425e-9648-e4f0951d1236",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "### Display result on bar chart"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "33765869-6cc4-45c5-9de5-7b9f4b420e5c",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": [
    "def create_barchart(df, repository):\n",
    "    # Get repository\n",
    "    repository = repository.split(\"/\")[-1]\n",
    "\n",
    "    # Sort df\n",
    "    df = df.sort_values(by=\"NB_COMMITS\")\n",
    "\n",
    "    # Calc commits\n",
    "    commits = df.NB_COMMITS.sum()\n",
    "\n",
    "    # Create fig\n",
    "    fig = px.bar(\n",
    "        df,\n",
    "        y=\"AUTHOR_NAME\",\n",
    "        x=\"NB_COMMITS\",\n",
    "        orientation=\"h\",\n",
    "        title=f\"GitHub - {repository} : Commits by user <br><span style='font-size: 13px;'>Total commits: {commits}</span>\",\n",
    "        text=\"NB_COMMITS\",\n",
    "        labels={\"AUTHOR_NAME\": \"Author\", \"NB_COMMITS\": \"Nb commits\"},\n",
    "    )\n",
    "    fig.update_traces(marker_color=\"black\")\n",
    "    fig.update_layout(\n",
    "        plot_bgcolor=\"#ffffff\",\n",
    "        width=1200,\n",
    "        height=800,\n",
    "        font=dict(family=\"Arial\", size=14, color=\"black\"),\n",
    "        paper_bgcolor=\"white\",\n",
    "        xaxis_title=None,\n",
    "        xaxis_showticklabels=False,\n",
    "        yaxis_title=None,\n",
    "        margin_pad=10,\n",
    "    )\n",
    "    fig.show()\n",
    "    return fig\n",
    "\n",
    "\n",
    "fig = create_barchart(df, repo_url)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "f7116feb-9248-45d6-af8d-2c54a234dafd",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "outputs": [],
   "source": []
  }
 ],
 "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": "19d43ffdcf1cb2f75a558259f7cfc3eed25577effd5690eb7a64e81cfacc9da9",
   "notebook_path": "GitHub/GitHub_Get_commits_ranking_from_repository.ipynb"
  },
  "papermill": {
   "default_parameters": {},
   "environment_variables": {},
   "parameters": {},
   "version": "2.3.4"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}