semvec/pypi-packages huggingface dataset:
colabcodeModbyBitGeek29 29.1
Mod version of ColabCode
License: MIT License
Requires Python: >3.5.2

# ColabCode

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
[![PyPI version](https://badge.fury.io/py/colabcode.svg)](https://badge.fury.io/py/colabcode)
![python version](https://img.shields.io/badge/python-3.6%2C3.7%2C3.8-blue?logo=python)

## Installation

```python
$ pip install colabcode
```

Run code server on [Google Colab](https://colab.research.google.com/) or [Kaggle](https://www.kaggle.com/) Notebooks.

## Getting Started

ColabCode also has a command-line script. So you can just run `colabcode` from command line.

**`colabcode -h`** will give the following:

```console
usage: colabcode [-h] --port PORT [--password PASSWORD] [--mount_drive]

ColabCode: Run VS Code On Colab / Kaggle Notebooks

required arguments:
  --port PORT          the port you want to run code-server on

optional arguments:
  --password PASSWORD  password to protect your code-server from unauthorized access
  --mount_drive        if you use --mount_drive, your google drive will be mounted
```

**Else**, you can do the following:

```python
# import colabcode
$ from colabcode import ColabCode
```

```python
# run colabcode with by default options.
$ ColabCode()
```

```python
# ColabCode has the following arguments:
# - port: the port you want to run code-server on, default 10000
# - password: password to protect your code server from being accessed by someone else.
#             Note that there is no password by default!
# - mount_drive: True or False to mount your Google Drive
$ ColabCode(port=10000, password="abhishek", mount_drive=True)
```

## How to use it?

**Colab** starter notebook: &nbsp;&nbsp; [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/abhishekkrthakur/colabcode/blob/master/colab_starter.ipynb)

**`ColabCode`**  comes pre-installed with some VS Code extensions.

### See an example in youtube video

[![YouTube Video](https://img.shields.io/youtube/views/7kTbM3D02jU?style=social)](https://youtu.be/7kTbM3D02jU)

## License

[MIT](LICENSE)