Rename vscode as flyin plugin (flyteorg#1986)

* rename vscode as flyin plugin

Signed-off-by: byhsu <[email protected]>

* fix lint

Signed-off-by: byhsu <[email protected]>

---------

Signed-off-by: byhsu <[email protected]>
Co-authored-by: byhsu <[email protected]>
Signed-off-by: Rafael Raposo <[email protected]>

.github/workflows/pythonbuild.yml

@@ -135,7 +135,7 @@ jobs:
           - flytekit-spark
           - flytekit-sqlalchemy
           - flytekit-vaex
-          - flytekit-vscode
+          - flytekit-flyin
           - flytekit-whylogs
         exclude:
           # flytekit-modin depends on ray which does not have a 3.11 wheel yet.

Dockerfile.dev

@@ -23,7 +23,7 @@ COPY . /flytekit
 RUN pip install -e /flytekit
 RUN pip install -e /flytekit/plugins/flytekit-k8s-pod
 RUN pip install -e /flytekit/plugins/flytekit-deck-standard
-RUN pip install -e /flytekit/plugins/flytekit-vscode
+RUN pip install -e /flytekit/plugins/flytekit-flyin
 RUN pip install scikit-learn
 
 ENV PYTHONPATH "/flytekit:/flytekit/plugins/flytekit-k8s-pod:/flytekit/plugins/flytekit-deck-standard:"

plugins/flytekit-vscode/README.md → plugins/flytekit-flyin/README.md

@@ -1,17 +1,26 @@
-# Flytekit VSCode Plugin
+# Flytekit FlyIn Plugin
 
-The Flytekit VSCode plugin offers an easy solution for users to run Python tasks within an interactive VSCode server, compatible with any image. `@vscode` is a decorator which users can put within @task and user function. With `@vscode`, the task will install vscode dependencies (skip if they already exist) and run a vscode server instead of the user defined functions.
+> Flyin = Flyte Interactive = Develop Flyte with the speed of flying
+
+FlyIn plugin provides users' favorite interface to develop and debug a flyte task interactively. We support vscode, jupyter (WIP), and neovim (WIP).
+
+## Installation
 
 To install the plugin, run the following command:
 
 ```bash
-pip install flytekitplugins-vscode
+pip install flytekitplugins-flyin
 ```
 
+## Vscode
+
+FlyIn Vscode offers an easy solution for users to run Python tasks within an interactive VSCode server, compatible with any image. `@vscode` is a decorator which users can put within @task and user function. With `@vscode`, the task will install vscode dependencies (skip if they already exist) and run a vscode server instead of the user defined functions.
+
+
 ## Starter Example
 ```python
 from flytekit import task
-from flytekitplugins.vscode import vscode
+from flytekitplugins.flyin import vscode
 
 @task
 @vscode
@@ -40,12 +49,11 @@ If users want to skip the vscode downloading process at runtime, they have the o
 + ENV PATH="/tmp/code-server/code-server-4.18.0-linux-amd64/bin:${PATH}"
 ```
 
-## More Examples
+## Advanced Examples
 
 ```python
 from flytekit import task, workflow
-from flytekitplugins.vscode import vscode, VscodeConfig
-from flytekitplugins.vscode.constants import DEFAULT_CODE_SERVER_EXTENSIONS
+from flytekitplugins.flyin import vscode, VscodeConfig, DEFAULT_CODE_SERVER_EXTENSIONS
 
 @task(
     container_image="localhost:30000/flytekit-vscode:0.0.2",

plugins/flytekit-flyin/flytekitplugins/flyin/__init__.py

@@ -0,0 +1,17 @@
+"""
+.. currentmodule:: flytekitplugins.flyin
+
+This package contains flyin plugin for Flytekit.
+
+.. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+
+   vscode
+   VscodeConfig
+   DEFAULT_CODE_SERVER_REMOTE_PATH
+   DEFAULT_CODE_SERVER_EXTENSIONS
+"""
+
+from .vscode_lib.decorator import vscode, VscodeConfig
+from .vscode_lib.constants import DEFAULT_CODE_SERVER_REMOTE_PATH, DEFAULT_CODE_SERVER_EXTENSIONS

plugins/flytekit-vscode/setup.py → plugins/flytekit-flyin/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup
 
-PLUGIN_NAME = "vscode"
+PLUGIN_NAME = "flyin"
 
 microlib_name = f"flytekitplugins-{PLUGIN_NAME}"
 
@@ -13,7 +13,7 @@
     version=__version__,
     author="flyteorg",
     author_email="[email protected]",
-    description="This package holds the vscode plugins for flytekit",
+    description="This package holds the flyin plugins for flytekit",
     namespace_packages=["flytekitplugins"],
     packages=[f"flytekitplugins.{PLUGIN_NAME}"],
     install_requires=plugin_requires,

plugins/flytekit-vscode/tests/test_vscode_plugin.py → plugins/flytekit-flyin/tests/test_flyin_plugin.py

@@ -1,13 +1,13 @@
 import mock
-from flytekitplugins.vscode import vscode
+from flytekitplugins.flyin import vscode
 
 from flytekit import task, workflow
 
 
 @mock.patch("multiprocessing.Process")
-@mock.patch("flytekitplugins.vscode.decorator.exit_handler")
-@mock.patch("flytekitplugins.vscode.decorator.download_vscode")
-def test_vscode_plugin(mock_download_vscode, mock_exit_handler, mock_process):
+@mock.patch("flytekitplugins.flyin.vscode_lib.decorator.exit_handler")
+@mock.patch("flytekitplugins.flyin.vscode_lib.decorator.download_vscode")
+def test_vscode(mock_download_vscode, mock_exit_handler, mock_process):
     @task
     @vscode
     def t():

plugins/setup.py

@@ -43,7 +43,7 @@
     "flytekitplugins-sqlalchemy": "flytekit-sqlalchemy",
     "flytekitplugins-vaex": "flytekit-vaex",
     "flytekitplugins-whylogs": "flytekit-whylogs",
-    "flytekitplugins-vscode": "flytekit-vscode",
+    "flytekitplugins-flyin": "flytekit-flyin",
 }