flyte 0.0.1b3__py3-none-any.whl → 0.2.0a0__py3-none-any.whl

flyte/{_cli → cli}/_delete.py

@@ -1,21 +1,21 @@
 import rich_click as click
 
-import flyte._cli._common as common
+import flyte.cli._common as common
 
 
 @click.group(name="delete")
 def delete():
     """
-    Delete a task or environment.
+    Remove resources from a Flyte deployment.
     """
 
 
-@click.command(cls=common.CommandBase)
+@delete.command(cls=common.CommandBase)
 @click.argument("name", type=str, required=True)
 @click.pass_obj
 def secret(cfg: common.CLIConfig, name: str, project: str | None = None, domain: str | None = None):
     """
-    Delete a secret.
+    Delete a secret. The name of the secret is required.
     """
     from flyte.remote import Secret
 

flyte/{_cli → cli}/_deploy.py

@@ -61,7 +61,7 @@ class DeployArguments:
     @classmethod
     def options(cls) -> List[click.Option]:
         """
-        Return the set of base parameters added to every pyflyte run workflow subcommand.
+        Return the set of base parameters added to every flyte run workflow subcommand.
         """
         return [common.get_option_from_metadata(f.metadata) for f in fields(cls) if f.metadata]
 
@@ -74,42 +74,51 @@ class DeployEnvCommand(click.Command):
         super().__init__(*args, **kwargs)
 
     def invoke(self, ctx: Context):
-        print(f"Deploying environment: {self.obj_name}")
+        from rich.console import Console
+
+        console = Console()
+        console.print(f"Deploying root - environment: {self.obj_name}")
         obj: CLIConfig = ctx.obj
         obj.init(self.deploy_args.project, self.deploy_args.domain)
-        return flyte.deploy(
-            self.obj,
-            dryrun=self.deploy_args.dry_run,
-            copy_style=self.deploy_args.copy_style,
-            version=self.deploy_args.version,
-        )
+        with console.status("Deploying...", spinner="dots"):
+            deployment = flyte.deploy(
+                self.obj,
+                dryrun=self.deploy_args.dry_run,
+                copy_style=self.deploy_args.copy_style,
+                version=self.deploy_args.version,
+            )
+
+        console.print(common.get_table("Environments", deployment.env_repr()))
+        console.print(common.get_table("Tasks", deployment.task_repr()))
 
 
 class EnvPerFileGroup(common.ObjectsPerFileGroup):
     """
-    Group that creates a command for each task in the current directory that is not __init__.py.
+    Group that creates a command for each task in the current directory that is not `__init__.py`.
     """
 
     def __init__(self, filename: Path, deploy_args: DeployArguments, *args, **kwargs):
+        args = (filename, *args)
         super().__init__(*args, **kwargs)
         self.deploy_args = deploy_args
 
     def _filter_objects(self, module: ModuleType) -> Dict[str, Any]:
-        return {k: v for k, v in module.__dict__.items() if isinstance(v, flyte.TaskEnvironment)}
+        return {k: v for k, v in module.__dict__.items() if isinstance(v, flyte.Environment)}
 
     def _get_command_for_obj(self, ctx: click.Context, obj_name: str, obj: Any) -> click.Command:
-        obj = cast(flyte.TaskEnvironment, obj)
+        obj = cast(flyte.Environment, obj)
         return DeployEnvCommand(
+            name=obj_name,
             obj_name=obj_name,
             obj=obj,
-            help=obj.description,
+            help=f"{obj.name}" + (f": {obj.description}" if obj.description else ""),
             deploy_args=self.deploy_args,
         )
 
 
 class EnvFiles(common.FileGroup):
     """
-    Group that creates a command for each file in the current directory that is not __init__.py.
+    Group that creates a command for each file in the current directory that is not `__init__.py`.
     """
 
     common_options_enabled = False
@@ -136,5 +145,8 @@ class EnvFiles(common.FileGroup):
 
 deploy = EnvFiles(
     name="deploy",
-    help="deploy one or more environments from a python file.",
+    help="""
+    Deploy one or more environments from a python file.
+    This command will create or update environments in the Flyte system.
+    """,
 )

flyte/cli/_gen.py

@@ -0,0 +1,163 @@
+import textwrap
+from os import getcwd
+from typing import Generator, Tuple
+
+import rich_click as click
+
+import flyte.cli._common as common
+
+
+@click.group(name="gen")
+def gen():
+    """
+    Generate documentation.
+    """
+
+
+@gen.command(cls=common.CommandBase)
+@click.option("--type", "doc_type", type=str, required=True, help="Type of documentation (valid: markdown)")
+@click.pass_obj
+def docs(cfg: common.CLIConfig, doc_type: str, project: str | None = None, domain: str | None = None):
+    """
+    Generate documentation.
+    """
+    if doc_type == "markdown":
+        markdown(cfg)
+    else:
+        raise click.ClickException("Invalid documentation type: {}".format(doc_type))
+
+
+def walk_commands(ctx: click.Context) -> Generator[Tuple[str, click.Command], None, None]:
+    """
+    Recursively walk a Click command tree, starting from the given context.
+
+    Yields:
+        (full_command_path, command_object)
+    """
+    command = ctx.command
+
+    if not isinstance(command, click.Group):
+        yield ctx.command_path, command
+    else:
+        for name in command.list_commands(ctx):
+            subcommand = command.get_command(ctx, name)
+            if subcommand is None:
+                continue
+
+            full_name = f"{ctx.command_path} {name}".strip()
+            yield full_name, subcommand
+
+            # Recurse if subcommand is a MultiCommand (i.e., has its own subcommands)
+            if isinstance(subcommand, click.Group):
+                sub_ctx = click.Context(subcommand, info_name=name, parent=ctx)
+                yield from walk_commands(sub_ctx)
+
+
+def markdown(cfg: common.CLIConfig):
+    """
+    Generate documentation in Markdown format
+    """
+    ctx = cfg.ctx
+
+    output = []
+    output_verb_groups: dict[str, list[str]] = {}
+    output_noun_groups: dict[str, list[str]] = {}
+
+    commands = [*[("flyte", ctx.command)], *walk_commands(ctx)]
+    for cmd_path, cmd in commands:
+        output.append("")
+
+        cmd_path_parts = cmd_path.split(" ")
+
+        if len(cmd_path_parts) > 1:
+            if cmd_path_parts[1] not in output_verb_groups:
+                output_verb_groups[cmd_path_parts[1]] = []
+            if len(cmd_path_parts) > 2:
+                output_verb_groups[cmd_path_parts[1]].append(cmd_path_parts[2])
+
+        if len(cmd_path_parts) == 3:
+            if cmd_path_parts[2] not in output_noun_groups:
+                output_noun_groups[cmd_path_parts[2]] = []
+            output_noun_groups[cmd_path_parts[2]].append(cmd_path_parts[1])
+
+        output.append(f"{'#' * (len(cmd_path_parts) + 1)} {cmd_path}")
+        if cmd.help:
+            output.append("")
+            output.append(f"{dedent(cmd.help)}")
+
+        if not cmd.params:
+            continue
+
+        params = cmd.get_params(click.Context(cmd))
+
+        # Collect all data first to calculate column widths
+        table_data = []
+        for param in params:
+            if isinstance(param, click.Option):
+                # Format each option with backticks before joining
+                all_opts = param.opts + param.secondary_opts
+                if len(all_opts) == 1:
+                    opts = f"`{all_opts[0]}`"
+                else:
+                    opts = "".join(
+                        [
+                            "{{< multiline >}}",
+                            "\n".join([f"`{opt}`" for opt in all_opts]),
+                            "{{< /multiline >}}",
+                        ]
+                    )
+                default_value = ""
+                if param.default is not None:
+                    default_value = f"`{param.default}`"
+                    default_value = default_value.replace(f"{getcwd()}/", "")
+                help_text = dedent(param.help) if param.help else ""
+                table_data.append([opts, f"`{param.type.name}`", default_value, help_text])
+
+        if not table_data:
+            continue
+
+        # Add table header with proper alignment
+        output.append("")
+        output.append("| Option | Type | Default | Description |")
+        output.append("|--------|------|---------|-------------|")
+
+        # Add table rows with proper alignment
+        for row in table_data:
+            output.append(f"| {row[0]} | {row[1]} | {row[2]} | {row[3]} |")
+
+    output_verb_index = []
+
+    if len(output_verb_groups) > 0:
+        output_verb_index.append("| Action | On |")
+        output_verb_index.append("| ------ | -- |")
+        for verb, nouns in output_verb_groups.items():
+            entries = [f"[`{noun}`](#flyte-{verb}-{noun})" for noun in nouns]
+            output_verb_index.append(f"| `{verb}` | {', '.join(entries)}  |")
+
+    output_noun_index = []
+
+    if len(output_noun_groups) > 0:
+        output_noun_index.append("| Object | Action |")
+        output_noun_index.append("| ------ | -- |")
+        for obj, actions in output_noun_groups.items():
+            entries = [f"[`{action}`](#flyte-{action}-{obj})" for action in actions]
+            output_noun_index.append(f"| `{obj}` | {', '.join(entries)}  |")
+
+    print()
+    print("{{< grid >}}")
+    print("{{< markdown >}}")
+    print("\n".join(output_noun_index))
+    print("{{< /markdown >}}")
+    print("{{< markdown >}}")
+    print("\n".join(output_verb_index))
+    print("{{< /markdown >}}")
+    print("{{< /grid >}}")
+    print()
+    print("\n".join(output))
+
+
+def dedent(text: str) -> str:
+    """
+    Remove leading whitespace from a string.
+    """
+    return textwrap.dedent(text).strip("\n")

flyte/{_cli → cli}/_get.py

@@ -11,7 +11,23 @@ from . import _common as common
 @click.group(name="get")
 def get():
     """
-    Get the value of a task or environment.
+    Retrieve resources from a Flyte deployment.
+
+    You can get information about projects, runs, tasks, actions, secrets, logs and input/output values.
+
+    Each command supports optional parameters to filter or specify the resource you want to retrieve.
+
+    Using a `get` subcommand without any arguments will retrieve a list of available resources to get.
+    For example:
+
+    * `get project` (without specifying a project), will list all projects.
+    * `get project my_project` will return the details of the project named `my_project`.
+
+    In some cases, a partially specified command will act as a filter and return available further parameters.
+    For example:
+
+    * `get action my_run` will return all actions for the run named `my_run`.
+    * `get action my_run my_action` will return the details of the action named `my_action` for the run `my_run`.
     """
 
 
@@ -20,11 +36,10 @@ def get():
 @click.pass_obj
 def project(cfg: common.CLIConfig, name: str | None = None):
     """
-    Get the current project.
+    Get a list of all projects, or details of a specific project by name.
     """
     from flyte.remote import Project
 
-    print(cfg)
     cfg.init()
 
     console = Console()
@@ -39,7 +54,11 @@ def project(cfg: common.CLIConfig, name: str | None = None):
 @click.pass_obj
 def run(cfg: common.CLIConfig, name: str | None = None, project: str | None = None, domain: str | None = None):
     """
-    Get the current run.
+    Get a list of all runs, or details of a specific run by name.
+
+    The run details will include information about the run, its status, but only the root action will be shown.
+
+    If you want to see the actions for a run, use `get action <run_name>`.
     """
     from flyte.remote import Run, RunDetails
 
@@ -56,16 +75,20 @@ def run(cfg: common.CLIConfig, name: str | None = None, project: str | None = No
 @get.command(cls=common.CommandBase)
 @click.argument("name", type=str, required=False)
 @click.argument("version", type=str, required=False)
+@click.option("--limit", type=int, default=100, help="Limit the number of tasks to show.")
 @click.pass_obj
 def task(
     cfg: common.CLIConfig,
     name: str | None = None,
+    limit: int = 100,
     version: str | None = None,
     project: str | None = None,
     domain: str | None = None,
 ):
     """
-    Get the current task.
+    Retrieve a list of all tasks, or details of a specific task by name and version.
+
+    Currently, both `name` and `version` are required to get a specific task.
     """
     from flyte.remote import Task
 
@@ -73,16 +96,16 @@ def task(
 
     console = Console()
     if name:
-        if not version:
-            raise click.BadParameter("Version is required when getting a task by name.")
-        v = Task.get(name=name, version=version)
-        if v is None:
-            raise click.BadParameter(f"Task {name} not found.")
-        t = v.fetch(v)
-        console.print(pretty_repr(t))
+        if version:
+            v = Task.get(name=name, version=version)
+            if v is None:
+                raise click.BadParameter(f"Task {name} not found.")
+            t = v.fetch()
+            console.print(pretty_repr(t))
+        else:
+            console.print(common.get_table("Tasks", Task.listall(by_task_name=name, limit=limit)))
     else:
-        raise click.BadParameter("Task listing is not supported yet, please provide a name.")
-        # console.print(common.get_table("Tasks", Task.listall()))
+        console.print(common.get_table("Tasks", Task.listall(limit=limit)))
 
 
 @get.command(cls=common.CommandBase)
@@ -112,17 +135,20 @@ def action(
 
 
 @get.command(cls=common.CommandBase)
-@click.argument("run_name", type=str, required=False)
+@click.argument("run_name", type=str, required=True)
 @click.argument("action_name", type=str, required=False)
-@click.option("--lines", "-l", type=int, default=30, help="Number of lines to show")
+@click.option("--lines", "-l", type=int, default=30, help="Number of lines to show, only useful for --pretty")
 @click.option("--show-ts", is_flag=True, help="Show timestamps")
 @click.option(
-    "--follow",
-    "-f",
+    "--pretty",
     is_flag=True,
     default=False,
-    help="Follow the logs (like tail -f), will open a panel with logs scrolling.",
+    help="Show logs in an auto-scrolling box, where number of lines is limited to `--lines`",
 )
+@click.option(
+    "--attempt", "-a", type=int, default=None, help="Attempt number to show logs for, defaults to the latest attempt."
+)
+@click.option("--filter-system", is_flag=True, default=False, help="Filter all system logs from the output.")
 @click.pass_obj
 def logs(
     cfg: common.CLIConfig,
@@ -132,17 +158,41 @@ def logs(
     domain: str | None = None,
     lines: int = 30,
     show_ts: bool = False,
-    follow: bool = True,
+    pretty: bool = True,
+    attempt: int | None = None,
+    filter_system: bool = False,
 ):
     """
-    Get the current run.
+    Stream logs for the provided run or action.
+    If only the run is provided, only the logs for the parent action will be streamed:
+
+    ```bash
+    $ flyte get logs my_run
+    ```
+
+    If you want to see the logs for a specific action, you can provide the action name as well:
+
+    ```bash
+    $ flyte get logs my_run my_action
+    ```
+
+    By default, logs will be shown in the raw format and will scroll the terminal.
+    If automatic scrolling and only tailing `--lines` number of lines is desired, use the `--pretty` flag:
+
+    ```bash
+    $ flyte get logs my_run my_action --pretty --lines 50
+    ```
     """
     import flyte.remote as remote
 
     cfg.init(project=project, domain=domain)
 
     async def _run_log_view(_obj):
-        task = asyncio.create_task(_obj.show_logs(max_lines=lines, show_ts=show_ts, raw=not follow))
+        task = asyncio.create_task(
+            _obj.show_logs(
+                max_lines=lines, show_ts=show_ts, raw=not pretty, attempt=attempt, filter_system=filter_system
+            )
+        )
         try:
             await task
         except KeyboardInterrupt:
@@ -165,7 +215,7 @@ def secret(
     domain: str | None = None,
 ):
     """
-    Get the current secret.
+    Get a list of all secrets, or details of a specific secret by name.
     """
     import flyte.remote as remote
 
@@ -195,6 +245,19 @@ def io(
 ):
     """
     Get the inputs and outputs of a run or action.
+    If only the run name is provided, it will show the inputs and outputs of the root action of that run.
+    If an action name is provided, it will show the inputs and outputs for that action.
+    If `--inputs-only` or `--outputs-only` is specified, it will only show the inputs or outputs respectively.
+
+    Examples:
+
+    ```bash
+    $ flyte get io my_run
+    ```
+
+    ```bash
+    $ flyte get io my_run my_action
+    ```
     """
     if inputs_only and outputs_only:
         raise click.BadParameter("Cannot use both --inputs-only and --outputs-only")
@@ -233,3 +296,15 @@ def io(
             f"[green bold]Inputs[/green bold]\n{inputs}\n\n[blue bold]Outputs[/blue bold]\n{outputs}",
         )
     )
+
+
+@get.command(cls=click.RichCommand)
+@click.pass_obj
+def config(cfg: common.CLIConfig):
+    """
+    Shows the automatically detected configuration to connect with the remote backend.
+
+    The configuration will include the endpoint, organization, and other settings that are used by the CLI.
+    """
+    console = Console()
+    console.print(cfg)