feat: Add shinylive url command

setup.cfg

@@ -36,6 +36,7 @@ install_requires =
     shiny
     click>=8.1.7
     appdirs>=1.4.4
+    lzstring>=1.0.4
 tests_require =
     pytest>=3
 zip_safe = False

shinylive/__init__.py

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

shinylive/_main.py

@@ -8,6 +8,7 @@
 import click
 
 from . import _assets, _deps, _export, _version
+from ._url import decode_shinylive_url, encode_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,153 @@ def defunct_help(cmd: str) -> str:
 """
 
 
+# #############################################################################
+# ## shinylive.io url
+# #############################################################################
+
+
+@main.group(
+    short_help="Create or decode a shinylive.io URL.",
+    help="Create or decode a shinylive.io URL.",
+    no_args_is_help=True,
+    cls=OrderedGroup,
+)
+def url() -> None:
+    pass
+
+
+@url.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 or directories for the app.
+
+On macOS, you can copy the URL to the clipboard with:
+
+    shinylive url encode app.py | pbcopy
+""",
+)
+@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, default="-")
+@click.argument("files", type=str, nargs=-1, required=False)
+def encode(
+    app: str,
+    files: Optional[tuple[str, ...]] = None,
+    mode: str = "editor",
+    language: Optional[str] = None,
+    no_header: bool = False,
+    view: bool = False,
+) -> None:
+    if app == "-":
+        app_in = sys.stdin.read()
+    else:
+        app_in = app
+
+    url = encode_shinylive_url(
+        app=app_in,
+        files=files,
+        mode=mode,
+        language=language,
+        header=not no_header,
+    )
+
+    print(url)
+
+    if view:
+        import webbrowser
+
+        webbrowser.open(url)
+    return
+
+
+@url.command(
+    short_help="Decode a shinylive.io URL.",
+    help="""
+Decode a shinylive.io URL.
+
+URL is the shinylive editor or app URL. If not specified, the URL will be read from
+stdin, allowing you to read the URL from a file or the clipboard.
+
+On macOS, you can read the URL from the clipboard with:
+
+    pbpaste | shinylive url decode
+""",
+)
+@click.option(
+    "--dir",
+    type=str,
+    default=None,
+    help="Output directory into which the app's files will be written. The directory is created if it does not exist. ",
+)
+@click.option(
+    "--json",
+    is_flag=True,
+    default=False,
+    help="Prints the decoded shinylive bundle as JSON to stdout, ignoring --out.",
+)
+@click.argument("url", type=str, nargs=1, default="-")
+def decode(url: str, dir: Optional[str] = None, json: bool = False) -> None:
+    if url == "-":
+        url_in = sys.stdin.read()
+    else:
+        url_in = url
+    bundle = decode_shinylive_url(str(url_in))
+
+    if json:
+        print_as_json(bundle)
+        return
+
+    if dir is not None:
+        import os
+
+        out_dir = Path(dir)
+        os.makedirs(out_dir, exist_ok=True)
+        for file in bundle:
+            with open(out_dir / file["name"], "w") as f_out:
+                f_out.write(
+                    file["content"].encode("utf-8", errors="ignore").decode("utf-8")
+                )
+    else:
+        print("")
+        for file in bundle:
+            print(f"## file: {file['name']}")
+            if "type" in file and file["type"] == "binary":
+                print("## type: binary")
+            print("")
+            print(file["content"].encode("utf-8", errors="ignore").decode("utf-8"))
+
+    return
+
+
+# #############################################################################
+# ## Deprecated commands
+# #############################################################################
+
+
 def defunct_error_txt(cmd: str) -> str:
     return f"Error: { defunct_help(cmd) }"