Skip to main content

An efficent python package to launch terminal in Google Colab

Project description

Google Colab Shell

Go to https://pypi.org/project/google-colab-shell/

Free Terminals for everyone
Displays a terminal for Google Colab
Go to https://pypi.org/project/google-colab-shell/ Go to https://pypi.org/project/google-colab-shell/ Go to https://pypi.org/project/google-colab-shell/ Language grade: Python Go to https://pypi.org/project/google-colab-shell/

Setup

pip install google-colab-shell

Usage

Open In Colab

# import the module once
from google_colab_shell import getshell
## Anytime you awnt to open a terminal

getshell()

getshell(height=400) # custom height of the terminal

IMPORTANT: Make sure getshell is the last command in the cell.

Documentation

Displays a terminal for Google Colab. <3 Google

Make sure this is the last command in the cell.

    Parameters
    ----------
    height : int, default 400
        height of the rendered terminal

    Returns
    -------
    IPython.display.HTML
        Displays the terminal

    Examples
    --------
    >>> getshell()

    >>> getshell(height=400)

Credits

Maintained by

Kuldeep Singh Sidhu

Github: github/singhsidhukuldeep https://github.com/singhsidhukuldeep

Website: Kuldeep Singh Sidhu (Website) http://kuldeepsinghsidhu.com

LinkedIn: Kuldeep Singh Sidhu (LinkedIn) https://www.linkedin.com/in/singhsidhukuldeep/

Contributors

The full list of all the contributors is available here

https://github.com/singhsidhukuldeep

TODO:: Want to contribute?

  • Add streaming of the output to have wider range of uses
  • Detach the terminal to be async with other cells
  • Set-up tests for edge cases and changes verification
  • Set-up CI/CD pipleine (possibly using GitHub actions) to publish changes to PyPi
  • Improeve the doc-strings documentation to add more explanantion and examples

Say Thanks

If this helped you in any way, it would be great if you could share it with others.

Steps for publishing to pypi [This is just for me, Maybe!]

  • pip3 install setuptools twine
  • Go to project folder
  • python3 setup.py sdist
  • twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

OR

Go to your project folder and:

pip3 install setuptools twine

python3 setup.py sdist
twine upload --repository-url https://upload.pypi.org/legacy/ dist/*

Current Status

Issues Contributors Forks Stars Watchers Branches

License: AGPL v3 made-with-python repo- size Followers

CHANGE LOG

0.2 (31/12/2021)

  • Fixed documentation

0.1 (31/12/2021)

  • Released first version(stable) of colab-shell.

Read more at https://github.com/singhsidhukuldeep/Google-Colab-Shell

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

google-colab-shell-0.2.tar.gz (4.2 kB view hashes)

Uploaded Source

Supported by

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