Metadata-Version: 2.1
Name: colab_everything
Version: 0.0.6
Summary: Python library to run streamlit, flask, fastapi, etc on google colab.
Home-page: https://github.com/Ankur-singh/colab_everything/tree/master/
Author: Ankur Singh
Author-email: as.ankursingh3.1@gmail.com
License: Apache Software License 2.0
Description: # colab_everything
        > Python library to run streamlit, flask, fastapi, etc on google colab.
        
        
        ## Install
        
        `pip install colab-everything`
        
        ## How to use
        
        **Note:** The library is only responsible for port tunneling. So, you will have setup everything required to run your web app. For example; installing all the dependecies, setting up all the environment varibles, etc.
        
        #### Streamlit app
        
        ```python
        from colab_everything import ColabStreamlit
        ColabStreamlit('app.py') # streamlit app path
        ```
        
        #### Flask app
        
        ```python
        from colab_everything import ColabFlask
        ColabFlask('app.py') # Flask app path
        ```
        
        #### FastAPI app
        
        **Note:** FastAPI uses `uvicorn`, so the syntax is a bit different. You will have to pass only the file name (without extention). For example, pass `main` if your app is `main.py`.
        
        ```python
        from colab_everything import ColabFastapi
        ColabFastapi('app') # FastAPI app file name
        ```
        
        #### Any other Custom app or command
        
        You can use `ColabCustom` to easily run an other app or command.
        
        To be very honest, you will never have to use `http.server` because colab already provides a file explorer. The example below is just for demonstration purposes.
        
        **Note:** The default port is 9999. If you are using any other port then you will have specify it twice; in the command and also in the argument.
        
        ```python
        ## Using default port
        from colab_everything import ColabCustom
        cmd = 'python -m http.server 9999'
        ColabCustom(cmd)
        ```
        
        ```python
        ## Using non-default port
        from colab_everything import ColabCustom
        cmd = 'python -m http.server 10000'
        ColabCustom(cmd, port=10000)
        ```
        
        I am actively looking for feedbacks and contributions. Feel free to contact me at *as.ankursingh3.1@gmail.com*.
        
Keywords: python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
