git_clone_my_amazing_project_to_gdrive.ipynb

{
  "cells": [
    {
      "cell_type": "markdown",
      "source": [
        "## Access\n",
        "<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
        "\n",
        "  <td>\n",
        "    <a target=\"_blank\" href=\"https://drive.google.com/file/d/18G3KcTxooGFvIEBu2QdwjZGKE4aEI4a-/view?usp=sharing\"><img src=\"https://www.tensorflow.org/images/colab_logo_32px.png\" />Run in Google Colab</a>\n",
        "  </td>\n",
        "  <td>\n",
        "    <a target=\"_blank\" href=\"https://github.com/wjlgatech/nbdev_colab/blob/master/git_clone_my_repo_to_gdrive.ipynb\"><img src=\"https://www.tensorflow.org/images/GitHub-Mark-32px.png\" />View source on GitHub</a>\n",
        "  </td>\n",
        "</table>"
      ],
      "metadata": {
        "id": "gEWTFu_AEqKd"
      }
    },
    {
      "cell_type": "code",
      "source": [
        "project_name = 'my_amazing_project'"
      ],
      "metadata": {
        "id": "2gWkVo6ixBoV"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
        "id": "lIYdn1woOS1n"
      },
      "outputs": [],
      "source": [
        "from google.colab import drive\n",
        "drive.mount('/content/drive')"
      ]
    },
    {
      "cell_type": "code",
      "source": [
        "#change working directory to my Google Drive, where I will clone repo and set up git\n",
        "\n",
        "%cd drive/MyDrive"
      ],
      "metadata": {
        "id": "--PiZN8KYTDJ"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "# assume that you had created a repo under your github account, called 'gml4people'\n",
        "!git clone https://github.com/wjlgatech/my_amazing_project.git"
      ],
      "metadata": {
        "id": "JVPwxJSKYYX1"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "#change directory to my project directory\n",
        "%cd my_amazing_project"
      ],
      "metadata": {
        "id": "JAgVSzjwYoC-"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "#inform git my username and email\n",
        "!git config user.name \"wjlgatech\"\n",
        "!git config user.email \"wjlgatech@gmail.com\""
      ],
      "metadata": {
        "id": "mNLpuMPtYzEJ"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "# export template 00_core.ipynb\n",
        "!pip3 install -e . -q\n",
        "!pip3 install nbdev -q\n",
        "!nbdev_build_lib"
      ],
      "metadata": {
        "id": "L0EEBZRfZAY0"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        ""
      ],
      "metadata": {
        "id": "prFE1d7UZRxV"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "markdown",
      "source": [
        "## Set up google drive and github for package development\n",
        "\n",
        "1. Mount your google drive\n",
        "2. change to package directory\n",
        "3. install the package\n",
        "4. install nbdev\n"
      ],
      "metadata": {
        "id": "1JSCt5DwXsQ4"
      }
    },
    {
      "cell_type": "code",
      "source": [
        "#hide\n",
        "!pip install -U nbdev\n",
        "!pip install fastcore -U # to deal with !nbdev_build_lib ImportError https://forums.fast.ai/t/nbdev-build-lib-importerror-cannot-import-name-documents-in-colab/97146/5\n"
      ],
      "metadata": {
        "id": "L7VR2mCrC8re"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "#export\n",
        "from pathlib import Path\n",
        "import os, subprocess\n",
        "from google.colab import drive\n",
        "\n",
        "def setup_ggldrive_github(path:str='drive/My Drive/'+project_name, \n",
        "                          project_name:str=project_name, \n",
        "                          username:str='wjlgatech', \n",
        "                          password:str='my_password', \n",
        "                          email:str='wjlgatech@gmail.com',\n",
        "                          ):\n",
        "  \"\"\"Mount your google drive & Link your mounted drive to GitHub. \n",
        "  ATTENTION: Remove sensitive information before pushing\n",
        "  \"\"\"\n",
        "  drive.mount('/content/drive', force_remount=True)\n",
        "\n",
        "  path = Path(path) #convert str to Path\n",
        "  start = os.getcwd()\n",
        "  os.chdir(path)\n",
        "  commands = []\n",
        "  commands.append(f\"git config --global user.email {email}\")\n",
        "  commands.append(f\"git config --global user.name {username}\")\n",
        "  commands.append(\"git init\")\n",
        "  commands.append(\"git remote rm origin\")\n",
        "  commands.append(f\"git remote add origin https://{username}:{password}@github.com/{username}/{project_name}.git\")\n",
        "  commands.append(\"git pull origin master --allow-unrelated-histories\")\n",
        "  for cmd in commands:\n",
        "    process = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)\n",
        "    output, err = process.communicate()\n",
        "  os.chdir(start)"
      ],
      "metadata": {
        "id": "sNWEZsroDnFr"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "path='drive/My Drive/'+project_name"
      ],
      "metadata": {
        "id": "kgIpgL2Fpn_g"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "setup_ggldrive_github(path=path, \n",
        "                      project_name=project_name, \n",
        "                      username='wjlgatech', \n",
        "                      password='my_github_token', \n",
        "                      email='wjlgatech@gmail.com',\n",
        "                      )"
      ],
      "metadata": {
        "id": "DpWxR4PdDnTO"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "markdown",
      "source": [
        "## Making package\n",
        "\n",
        "If you want to\n",
        "- to push the changes of this notebook into your repo in your google drive \n",
        "- to make it a package,\n",
        "\n",
        "execute the following:"
      ],
      "metadata": {
        "id": "ibgi-aqS4gxL"
      }
    },
    {
      "cell_type": "code",
      "source": [
        "#export\n",
        "def git_push(path:str='drive/My Drive/'+project_name, \n",
        "             message:str='my 1st push'):\n",
        "  \"Convert the notebooks to scripts and then push to the library\"\n",
        "  path = Path(path) #convert str to Path\n",
        "  start = os.getcwd()\n",
        "  os.chdir(path)\n",
        "  commands = []\n",
        "  commands.append('nbdev_install_git_hooks')\n",
        "  commands.append('nbdev_build_lib')\n",
        "  commands.append('git add *')\n",
        "  commands.append(f'git commit -m \"{message}\"')\n",
        "  commands.append('git push origin master')\n",
        "  for cmd in commands:\n",
        "    process = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE)\n",
        "    output, err = process.communicate()\n",
        "  os.chdir(start)"
      ],
      "metadata": {
        "id": "rUTYqC584vgo"
      },
      "execution_count": null,
      "outputs": []
    },
    {
      "cell_type": "code",
      "source": [
        "git_push(path=path, \n",
        "         message='my 1st push')"
      ],
      "metadata": {
        "id": "go3UmGMg5V4d"
      },
      "execution_count": null,
      "outputs": []
    }
  ],
  "metadata": {
    "colab": {
      "name": "git_clone_my_repo_to_gdrive.ipynb",
      "provenance": [],
      "private_outputs": true,
      "toc_visible": true
    },
    "kernelspec": {
      "display_name": "Python 3",
      "name": "python3"
    },
    "gpuClass": "standard"
  },
  "nbformat": 4,
  "nbformat_minor": 0
}