feat: Add shinylive url command

shinylive/__init__.py

@@ -1,5 +1,8 @@
 """A package for packaging Shiny applications that run on Python in the browser."""
 
 from . import _version
+from ._url import make_shinylive_url
 
 __version__ = _version.SHINYLIVE_PACKAGE_VERSION
+
+__all__ = ("make_shinylive_url",)

shinylive/_main.py

@@ -8,6 +8,7 @@
 import click
 
 from . import _assets, _deps, _export, _version
+from ._url import make_shinylive_url
 from ._utils import print_as_json
 
 
@@ -59,6 +60,7 @@ def list_commands(self, ctx: click.Context) -> list[str]:
 #         * language-resources
 #         * app-resources
 #             * Options: --json-file / stdin (required)
+#     * url
 
 
 # #############################################################################
@@ -469,6 +471,76 @@ def defunct_help(cmd: str) -> str:
 """
 
 
+# #############################################################################
+# ## shinylive.io link
+# #############################################################################
+
+
+@main.command(
+    short_help="Create a shinylive.io URL from local files.",
+    help="""
+Create a shinylive.io URL for a Shiny app from local files.
+
+APP is the path to the primary Shiny app file.
+
+FILES are additional supporting files for the app.
+""",
+    no_args_is_help=True,
+)
+@click.option(
+    "-m",
+    "--mode",
+    type=click.Choice(["editor", "app"]),
+    required=True,
+    default="editor",
+    help="The shinylive mode: include the editor or show only the app.",
+)
+@click.option(
+    "-l",
+    "--language",
+    type=click.Choice(["python", "py", "R", "r"]),
+    required=False,
+    default=None,
+    help="The primary language used to run the app, by default inferred from the app file.",
+)
+@click.option(
+    "-v", "--view", is_flag=True, default=False, help="Open the link in a browser."
+)
+@click.option(
+    "--no-header", is_flag=True, default=False, help="Hide the Shinylive header."
+)
+@click.argument("app", type=str, nargs=1, required=True)
+@click.argument("files", type=str, nargs=-1, required=False)
+def url(
+    app: str,
+    files: Optional[tuple[str, ...]] = None,
+    mode: str = "editor",
+    language: Optional[str] = None,
+    no_header: bool = False,
+    view: bool = False,
+) -> None:
+    url = make_shinylive_url(
+        app=app,
+        files=files,
+        mode=mode,
+        language=language,
+        no_header=no_header,
+    )
+
+    print(url)
+
+    if view:
+        import webbrowser
+
+        webbrowser.open(url)
+    return
+
+
+# #############################################################################
+# ## Deprecated commands
+# #############################################################################
+
+
 def defunct_error_txt(cmd: str) -> str:
     return f"Error: { defunct_help(cmd) }"
 

shinylive/_url.py

@@ -0,0 +1,96 @@
+import base64
+import json
+from pathlib import Path
+from typing import List, Literal, Optional, TypedDict, cast
+
+from lzstring import LZString  # type: ignore[reportMissingTypeStubs]
+
+
+def make_shinylive_url(
+    app: str | Path,
+    files: Optional[tuple[str | Path, ...]] = None,
+    mode: str = "editor",
+    language: Optional[str] = None,
+    no_header: bool = False,
+) -> str:
+    """
+    Generate a URL for a [ShinyLive application](https://shinylive.io).
+
+    Parameters
+    ----------
+    app
+        The main app file of the ShinyLive application. This file should be a Python
+        `app.py` or an R `app.R`, `ui.R`, or `server.R` file. This file will be renamed
+         `app.py` or `app.R` for shinylive, unless it's named `ui.R` or `server.R`.
+    files
+        A tuple of file paths to include in the application. On shinylive, these files
+        will be given stored relative to the main `app` file.
+    mode
+        The mode of the application. Defaults to "editor".
+    language
+        The language of the application. Defaults to None.
+    no_header
+        Whether to include a header. Defaults to False.
+
+    Returns
+    -------
+        The generated URL for the ShinyLive application.
+    """
+    root_dir = Path(app).parent
+    file_bundle = [read_file(app, root_dir)]
+
+    if files is not None:
+        file_bundle = file_bundle + [read_file(file, root_dir) for file in files]
+
+    if language is None:
+        language = file_bundle[0]["name"].split(".")[-1].lower()
+    else:
+        language = "py" if language.lower() in ["py", "python"] else "r"
+
+    # if first file is not named either `ui.R` or `server.R`, then make it app.{language}
+    if file_bundle[0]["name"] not in ["ui.R", "server.R"]:
+        file_bundle[0]["name"] = f"app.{'py' if language == 'py' else 'R'}"
+
+    file_lz = lzstring_file_bundle(file_bundle)
+
+    base = "https://shinylive.io"
+
+    return f"{base}/{language}/{mode}/#{'h=0&' if no_header else ''}code={file_lz}"
+
+
+class FileContentJson(TypedDict):
+    name: str
+    content: str
+    type: Literal["text", "binary"]
+
+
+def read_file(file: str | Path, root_dir: str | Path | None = None) -> FileContentJson:
+    file = Path(file)
+    if root_dir is None:
+        root_dir = Path("/")
+    root_dir = Path(root_dir)
+
+    type: Literal["text", "binary"] = "text"
+
+    try:
+        with open(file, "r") as f:
+            file_content = f.read()
+            type = "text"
+    except UnicodeDecodeError:
+        # If text failed, try binary.
+        with open(file, "rb") as f:
+            file_content_bin = f.read()
+            file_content = base64.b64encode(file_content_bin).decode("utf-8")
+            type = "binary"
+
+    return {
+        "name": str(file.relative_to(root_dir)),
+        "content": file_content,
+        "type": type,
+    }
+
+
+def lzstring_file_bundle(file_bundle: List[FileContentJson]) -> str:
+    file_json = json.dumps(file_bundle)
+    file_lz = LZString.compressToEncodedURIComponent(file_json)  # type: ignore[reportUnknownMemberType]
+    return cast(str, file_lz)