Skip to main content

Generates Google Colab link for jupyter notebooks in public Github repos.

Project description

Github to Colab Link Generator

Build Status

Sometimes you may want to load a Jupyter notebook from your repo to colab and run it there. Other times you may just want to add a colab link to your repositories readme page. Sure you can download a notebook and then import to colab but that may not always be ideal. The goal of this cli tool is to short-circuit that process so that you don't have to go through the extra clicks.

Pre-requisites

  • The repo where your notebook is must be public

Installation and Usage

Install from pip

pip install -U github-to-colab-link

Usage

The package currently generates links in two formats, one is a plain string, which you can copy and load in an web browser; another is a markdown embed which you can use in your markdown style docs, e.g. Github readmes.

# for plain string
colab-link-gen --string --gh link_to_notebook
# example
colab-link-gen --string --gh https://github.com/ShawonAshraf/jax_examples/blob/main/playground/palmers_penguins.ipynb
# for markdown embed
colab-link-gen --md --gh link_to_notebook
# example
colab-link-gen --md --gh https://github.com/ShawonAshraf/jax_examples/blob/main/playground/palmers_penguins.ipynb

Dev

  • Clone the repo
  • Create a virtualenv
  • Install the requirements
pip install -r requirements.txt
  • The entrypoint for the cli tool is in cli.py (the run() function)
  • link.py contains the helpers to generate the links

Testing

python -m unittest discover -s ./tests -p "*_test.py"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github-to-colab-link-1.0.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

github_to_colab_link-1.0.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page