colabcode - pypi Package Compare versions

Comparing version 0.0.7 to 0.0.8

colabcode.egg-info/PKG-INFO

 Metadata-Version: 2.1
 Name: colabcode
-Version: 0.0.7
+Version: 0.0.8
 Summary: ColabCode - Run codeserver on Colab!
@@ -11,21 +11,61 @@ Home-page: https://github.com/abhishekkrthakur/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)
+        
+        
+        
+        
         Run code server on Google Colab or Kaggle Notebooks
         
-        Quickstart:
-        - install colabcode: `pip install colabcode`
-        - import colabcode: `from colabcode import ColabCode`
-        - run: `ColabCode(port=10000, password="abhishek")`
-        - you can also run it with any password or port :)
+        ## Getting Started
         
+        ColabCode also has a command-line script. So you can just run `colabcode` from command line.
+        
+        `colabcode -h` will give the following:
+        
+        ```
+        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:
+        
+        
+        ```shell
+        # install colabcode
+        $ pip install colabcode
+        
+        # import colabcode
+        $ from colabcode import ColabCode
+        
+        # run colabcode with by deafult options.
+        $ ColabCode()
+        
+        # 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: [![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` 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` comes pre-installed with some VS Code extensions.
         
-        See an example in [this video tutorial](https://www.youtube.com/watch?v=7kTbM3D02jU).
+        ##### See an example in youtube video     [![YouTube Video](https://img.shields.io/youtube/views/7kTbM3D02jU?style=social)](https://youtu.be/7kTbM3D02jU)
         
+        ## License
+        
+        [MIT](LICENSE)
+        
 Platform: linux
@@ -32,0 +72,0 @@ Platform: unix

colabcode.egg-info/SOURCES.txt

@@ -9,2 +9,3 @@ README.md
 colabcode.egg-info/requires.txt
-colabcode.egg-info/top_level.txt
+colabcode.egg-info/top_level.txt
+scripts/colabcode

PKG-INFO

 Metadata-Version: 2.1
 Name: colabcode
-Version: 0.0.7
+Version: 0.0.8
 Summary: ColabCode - Run codeserver on Colab!
@@ -11,21 +11,61 @@ Home-page: https://github.com/abhishekkrthakur/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)
+        
+        
+        
+        
         Run code server on Google Colab or Kaggle Notebooks
         
-        Quickstart:
-        - install colabcode: `pip install colabcode`
-        - import colabcode: `from colabcode import ColabCode`
-        - run: `ColabCode(port=10000, password="abhishek")`
-        - you can also run it with any password or port :)
+        ## Getting Started
         
+        ColabCode also has a command-line script. So you can just run `colabcode` from command line.
+        
+        `colabcode -h` will give the following:
+        
+        ```
+        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:
+        
+        
+        ```shell
+        # install colabcode
+        $ pip install colabcode
+        
+        # import colabcode
+        $ from colabcode import ColabCode
+        
+        # run colabcode with by deafult options.
+        $ ColabCode()
+        
+        # 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: [![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` 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` comes pre-installed with some VS Code extensions.
         
-        See an example in [this video tutorial](https://www.youtube.com/watch?v=7kTbM3D02jU).
+        ##### See an example in youtube video     [![YouTube Video](https://img.shields.io/youtube/views/7kTbM3D02jU?style=social)](https://youtu.be/7kTbM3D02jU)
         
+        ## License
+        
+        [MIT](LICENSE)
+        
 Platform: linux
@@ -32,0 +72,0 @@ Platform: unix

README.md

 # 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)
+
+
+
+
 Run code server on Google Colab or Kaggle Notebooks
 
-Quickstart:
-- install colabcode: `pip install colabcode`
-- import colabcode: `from colabcode import ColabCode`
-- run: `ColabCode(port=10000, password="abhishek")`
-- you can also run it with any password or port :)
+## Getting Started
 
+ColabCode also has a command-line script. So you can just run `colabcode` from command line.
+
+`colabcode -h` will give the following:
+
+```
+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:
+
+
+```shell
+# install colabcode
+$ pip install colabcode
+
+# import colabcode
+$ from colabcode import ColabCode
+
+# run colabcode with by deafult options.
+$ ColabCode()
+
+# 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: [![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` 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` comes pre-installed with some VS Code extensions.
 
-See an example in [this video tutorial](https://www.youtube.com/watch?v=7kTbM3D02jU).
+##### See an example in youtube video     [![YouTube Video](https://img.shields.io/youtube/views/7kTbM3D02jU?style=social)](https://youtu.be/7kTbM3D02jU)
+
+## License
+
+[MIT](LICENSE)

setup.py

 from setuptools import setup, Extension
 from setuptools import find_packages
 
-with open("README.md", encoding="utf-8") as f:
+with open("README.md") as f:
     long_description = f.read()
@@ -11,3 +11,4 @@
         name="colabcode",
-        version="0.0.7",
+        scripts=["scripts/colabcode"],
+        version="0.0.8",
         description="ColabCode - Run codeserver on Colab!",
@@ -14,0 +15,0 @@ long_description=long_description,

Alert delta unavailable

Currently unable to show alert delta for PyPI packages.

Improved metrics

Total package byte prevSize

11349

68.43%

Number of package files

12

9.09%

Lines of code

73

1.39%