---

title: nbd_colab

keywords: fastai
sidebar: home_sidebar

summary: "API details."
---
<!--

#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: 00_core.ipynb
# command to build the docs after a change: nbdev_build_docs

-->

<div class="container" id="notebook-container">
    
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h4 id="drive_setup" class="doc_header"><code>drive_setup</code><a href="https://github.com/hallmx/nbd_colab/tree/master/nbd_colab/core.py#L15" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>drive_setup</code>()</p>
</blockquote>
<p>Connect Google Drive to Colab instance</p>

</div>

</div>

</div>
</div>

</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h4 id="change_dir" class="doc_header"><code>change_dir</code><a href="https://github.com/hallmx/nbd_colab/tree/master/nbd_colab/core.py#L25" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>change_dir</code>(<strong><code>path</code></strong>)</p>
</blockquote>

</div>

</div>

</div>
</div>

</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Set the users home directory.</p>

</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h4 id="clone_new_repo" class="doc_header"><code>clone_new_repo</code><a href="https://github.com/hallmx/nbd_colab/tree/master/nbd_colab/core.py#L63" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>clone_new_repo</code>()</p>
</blockquote>
<p>Clone repo from github to google drive and configure</p>

</div>

</div>

</div>
</div>

</div>
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Function to clone a remote repo on github to creat a local repo at a specified destination on google drive.</p>
<p>The repo will be cloned to '/conten/drive/My Drive' by default.</p>
<p>After successful cloning, the local repo is automatically configured with users name, email, and password to allow automatic authentication for github integration. This requires the users github credentials (username and password) to be stored in the local repo on google drive (in the .git.config file). Sharing the local repo should therefore be avoided as this risks exposing your github authentication credentials to others.</p>
<p>Automatic notebook cleaning using nbdev_install_git_hooks is also activated to to ensure notebook metadata is sanitised to smooth github integration.</p>

</div>
</div>
</div>
<div class="cell border-box-sizing code_cell rendered">

</div>
<div class="cell border-box-sizing code_cell rendered">

<div class="output_wrapper">
<div class="output">

<div class="output_area">


<div class="output_markdown rendered_html output_subarea ">
<h4 id="setup_nb" class="doc_header"><code>setup_nb</code><a href="https://github.com/hallmx/nbd_colab/tree/master/nbd_colab/core.py#L109" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>setup_nb</code>(<strong><code>repo</code></strong>, <strong><code>dir</code></strong>=<em><code>None</code></em>)</p>
</blockquote>
<p>Setup a new module notebook for use with nbdev</p>

</div>

</div>

</div>
</div>

</div>
</div>