colab-assist 0.1.2

Google Colab workflow utilities

colab-assist

Utilities that assist development workflows on Google Colab

Documentation · Issues · PyPI

About

• colab-assist is a small package that shares utility functions I find useful for my development workflows on Google Colab.

• Actually, this is also a semi-mock project that I use to learn Python open-source development. Feedbacks, guidance, and feature suggestions are much appreciated!

Usage

Experimenting your private Python package on Colab

1. Develop your package any way you like and push it to your private GitHub repo.

2. Make a repo-specific personal access token (PAT).

3. Store the PAT as a Colab Secret:

   

4. On Colab:

   import colab_assist as A
   

   • Install → experiment → push → resintall:

     # Install your private package
     A.install_gh("me/my_pkg", "dev", secret="my_token")
     
     # Experiment
     from my_pkg import foo
     foo()
     
     # (Push update accordingly to the development branch of your repo)
     
     # Reinstall updated package
     A.install_gh("me/my_pkg", "dev", secret="my_token")
     
     # Reimport updated functions/classes without needing to restart Colab session
     foo = A.reload(foo)
     foo()
     

   • Or clone → experiment → push → pull:

     # Clone your private package and add it to `sys.path`
     A.clone_gh("me/my_pkg", "dev", opt="p", secret="my_token")
     
     # Experiment
     from my_pkg import foo
     foo()
     
     # (Push updates accordingly to the development branch of your repo)
     
     # Pull the update
     A.pull_gh("my_pkg")
     
     # Reimport updated functions/classes without needing to restart Colab session
     foo = A.reload(foo)
     foo()
     

Dependencies & Installation

• Although currently colab-assist lists no dependency, it is intended to only be installed and used in a Google Colab environment. The reason not to explicitly list dependencies for now is that at least one depedency (google-colab) is bespoke for Colab and not hosted on PyPI. However, colab-assist is designed to install and run just fine on a fresh Colab instance.

• You can install colab-assist very quickly with the pre-installed uv on Colab:

  !uv pip install --system -qU colab-assist
  

  Or with pip:

  %pip install -qU colab-assist
  

• This package is currently a single-file package. Therefore you may use it quick and dirty by just downloading the module file:

  !wget -q https://raw.githubusercontent.com/dd-n-kk/colab-assist/master/src/colab_assist/colab_assist.py
  

License

• MIT license

Acknowledgements

• uv
• MkDocs
• Material for MkDocs
• mkdocstrings
• Awesome Readme Template