Generates Google Colab link for jupyter notebooks in public Github repos.
Project description
Github to Colab Link Generator
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
(therun()
function) link.py
contains the helpers to generate the links
Testing
python -m unittest discover -s ./tests -p "*_test.py"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file github-to-colab-link-1.0.1.tar.gz
.
File metadata
- Download URL: github-to-colab-link-1.0.1.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
04c8f394cc32ef3720f4e4228e67da2f86ff15197ab900db4cc8dba66b51d8ca
|
|
MD5 |
6391afdf6303fb9b6ae6741738f6d6d6
|
|
BLAKE2b-256 |
b31205012a435b3875db67b03cdf239380f16fa8f2a93596a8e6ea31457ffed1
|
File details
Details for the file github_to_colab_link-1.0.1-py3-none-any.whl
.
File metadata
- Download URL: github_to_colab_link-1.0.1-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
439065cde38a172e99a43e1bb5d760588c326416954587883b8a14cda4dfb939
|
|
MD5 |
0aad44183062f79a3648107999889134
|
|
BLAKE2b-256 |
f859ad64417d8495e5b91302fcb6f4fc8df8bf6b170642661221eaf19cb74d38
|