cvdlink 0.1.1__tar.gz

cvdlink-0.1.1/FeatureCloud/api/cli/__main__.py

@@ -0,0 +1,115 @@
+import click
+import requests
+from importlib.metadata import version, PackageNotFoundError
+
+from FeatureCloud.api.cli.test.commands import test
+from FeatureCloud.api.cli.controller.commands import controller
+from FeatureCloud.api.cli.app.commands import app
+
+
+def _safe_version(*dist_names: str) -> str:
+    """
+    Return the installed distribution version for the first matching name.
+    Avoids crashing if a distribution name is not installed in the environment.
+    """
+    for name in dist_names:
+        try:
+            return version(name)
+        except PackageNotFoundError:
+            continue
+    return "0.0.0+unknown"
+
+
+def get_latest_version(package_name: str):
+    url = f"https://pypi.org/pypi/{package_name}/json"
+    try:
+        response = requests.get(url, timeout=3)
+        response.raise_for_status()
+        data = response.json()
+        return data["info"]["version"]
+    except requests.exceptions.RequestException:
+        return None
+
+
+def get_warning_string():
+    """
+    Warn if local FeatureCloud version appears older than PyPI 'featurecloud'.
+    Never crash if the package metadata doesn't exist (e.g., editable installs, renamed dists).
+    """
+    online_version = get_latest_version("featurecloud")
+    if not online_version:
+        return None
+
+    online_version_list = online_version.split(".")
+
+    # Use only the distribution names that actually exist in your env.
+    # In your output, FeatureCloud is installed (editable) and featurecloud is available as normalized.
+    local_version = _safe_version("FeatureCloud", "featurecloud")
+
+    if local_version == "0.0.0+unknown":
+        return None
+
+    local_version_list = local_version.split(".")
+
+    for idx in range(min(len(online_version_list), len(local_version_list))):
+        try:
+            if int(online_version_list[idx]) > int(local_version_list[idx]):
+                click.echo(
+                    click.style(
+                        f"WARNING: your version is out of date. "
+                        f"Your version is {local_version} but "
+                        f"version {online_version} is available",
+                        fg="yellow",
+                        bold=True,
+                    )
+                )
+                break
+        except Exception:
+            return None
+
+    return None
+
+
+
+
+def _init_ctx_profile(ctx: click.Context, default_profile: str) -> None:
+    """Initialize click context object with a default profile."""
+    ctx.ensure_object(dict)
+    # Only set if not already set, so nested calls won't overwrite
+    ctx.obj.setdefault("profile", default_profile)
+
+
+# ---------- FeatureCloud CLI root ----------
+
+@click.version_option(version=_safe_version("featurecloud", "FeatureCloud", "cvdlink"))
+@click.group("first-level", epilog=get_warning_string())
+@click.pass_context
+def fc_cli(ctx: click.Context) -> None:
+    """FeatureCloud CLI."""
+    _init_ctx_profile(ctx, default_profile="featurecloud")
+
+
+fc_cli.add_command(test)
+fc_cli.add_command(controller)
+fc_cli.add_command(app)
+
+
+# ---------- CVDLink CLI root ----------
+
+@click.version_option(version=_safe_version("cvdlink", "featurecloud", "FeatureCloud"))
+@click.group("first-level", epilog=get_warning_string())
+@click.pass_context
+def cvdlink_cli(ctx: click.Context) -> None:
+    """CVDLink CLI (based on FeatureCloud)."""
+    _init_ctx_profile(ctx, default_profile="cvdlink")
+
+
+cvdlink_cli.add_command(test)
+cvdlink_cli.add_command(controller)
+cvdlink_cli.add_command(app)
+
+
+if __name__ == "__main__":
+    # Fallback if someone runs `python -m FeatureCloud.api.cli.__main__`
+    # Default to FeatureCloud behavior.
+    fc_cli()

cvdlink-0.1.1/FeatureCloud/api/cli/app/commands.py

@@ -0,0 +1,182 @@
+import os
+import click
+import tqdm
+
+from FeatureCloud.api.imp.app import commands
+from FeatureCloud.api.imp.exceptions import FCException
+
+
+@click.group("app")
+def app() -> None:
+    """app related commands"""
+
+
+# @TODO Create a list available templates function
+
+@app.command('new')
+@click.argument('name', type=click.Path(), nargs=1)
+@click.argument('directory', type=click.Path(), nargs=1, required=False)
+@click.option('--template-name',
+              help='You can specify a template from the available ones: app-blank, app-dice, app-round. '
+                   'If not provided, an empty project will be created using the app-blank template.')
+def new(name: click.Path, directory: click.Path, template_name: str):
+    """
+    Create new app
+
+    NAME is the app name. Because of Docker naming restrictions, it should be in lowercase.
+
+    DIRECTORY is the directory where your app will be created (in a subdirectory NAME)
+
+    Example: featurecloud app new my-new-app . --template-name=app-blank
+
+    """
+    try:
+        arguments = locals().items()
+        for key, value in arguments:
+            if key == 'name':
+                value_lowercase = value.lower()
+                if value != value_lowercase:
+                    click.echo("Uppercase letters are not allowed in app name. The new app name is: " + value_lowercase)
+
+        path = commands.new(**{k: v for k, v in arguments if v})
+        click.echo(f'Path to your app: {os.path.abspath(path)}')
+        click.echo('Enjoy!')
+    except FCException as e:
+        click.echo(f'Error: {e}')
+
+
+@app.command('build')
+@click.argument('path', type=click.Path(), default=".", required=False)
+@click.argument('image_name', type=str, default='', required=False)
+@click.argument('tag', type=str, default="latest", nargs=1, required=False)
+@click.argument('rm', type=bool, default=True, nargs=1, required=False)
+def build(path: click.Path, image_name: str, tag: str, rm: bool):
+    """
+
+    Build app
+
+    PATH is the location of your app
+
+    IMAGE_NAME is the Docker image name. Because of Docker naming restrictions, it should be in lowercase.
+
+    TAG the Docker tag for the version to be built. Default: 'latest'.
+
+    RM remove intermediary containers.
+
+    Example: featurecloud app build ./my-new-app my-new-app first_version True
+    """
+    try:
+        arguments = locals().items()
+        for key, value in arguments:
+            if key == 'image_name':
+                value_lowercase = value.lower()
+                if value != value_lowercase:
+                    click.echo(
+                        "Uppercase letters are not allowed in image name. The new image name is: " + value_lowercase)
+        click.echo(f'Building {image_name}:{tag} ...')
+        build_log_generator = commands.build(**{k: v for k, v in arguments if v})
+        # Iterate over the response
+        for output in build_log_generator:  
+            if 'stream' in output:
+                stream_output = output['stream'].strip()
+                if 'Step' in stream_output:
+                    click.echo(stream_output)
+        click.echo(f'Image {image_name}:{tag} built successfully')
+    except FCException as e:
+        click.echo(f'Error: {e}')      
+
+
+@app.command('download')
+@click.argument('name', type=str, default=None, nargs=1, required=True)
+@click.argument('tag', type=str, default="latest", nargs=1, required=False)
+def download(name: str, tag: str):
+    """
+    Download an image from FeatureCloud repository
+
+    NAME is the image name
+
+    TAG is the image versioning tag. Default: 'latest'.
+
+    Example: featurecloud app download my_app:latest
+    """
+    try:
+        result = commands.download(**{k: v for k, v in locals().items() if v})
+        for _ in tqdm.tqdm(result, desc=f"Downloading {name}:{tag} ..."):
+            pass
+    except FCException as e:
+        click.echo(f'Error: {e}')
+
+
+@app.command('publish')
+@click.argument('name', type=str, default=None, nargs=1, required=True)
+@click.argument('tag', type=str, default="latest", nargs=1, required=False)
+def publish(name: str, tag: str):
+    """
+    Publish an app in FeatureCloud repository
+
+    NAME is the image name
+
+    TAG is the image versioning tag. Default: 'latest'.
+
+    Example: featurecloud app publish my-app:latest
+
+    The app should be created and the image name set in the AI Store prior publishing
+
+    """
+    try:
+        result = commands.publish(**{k: v for k, v in locals().items() if v})
+        for _ in tqdm.tqdm(result, desc=f"Uploading {name}:{tag} ..."):
+            pass
+    except FCException as e:
+        if str(e).find("authentication required") > -1:
+            click.echo(
+                f'Image cannot be pushed. A docker login is necessary to featurecloud.ai with user credentials or the app is inexistent in Featurecloud AI Store. In this case please create an app in AI Store with the specified image name.')
+        click.echo(f'Error: {e}')
+
+
+@app.command('remove')
+@click.argument('name', type=str, default=None, nargs=1, required=True)
+@click.argument('tag', type=str, default="latest", nargs=1, required=False)
+def remove(name: str, tag: str):
+    """
+    Delete app image(s) from the local repository. This command will not delete the app from FeatureCloud AI Store.
+
+    NAME is the image name to be deleted
+
+    TAG is the image versioning tag. If set to 'all', all versions will be deleted. Default: 'latest'.
+
+    Example: featurecloud app remove my-app all
+    """
+    try:
+        result = commands.remove(**{k: v for k, v in locals().items() if v})
+        if len(result) == 0:
+            click.echo(f'No image found')
+        else:
+            click.echo(f'Removed image(s): {",".join(result)}')
+    except FCException as e:
+        click.echo(f'Error: {e}')
+
+
+@app.command('plot-states')
+@click.argument('path', type=click.Path(), default=".", required=False)
+@click.option('--package', default=".", help='package/s which include/s the states')
+@click.option('--states', default='main', help='python files containing the states seperated by comma')
+@click.option('--plot_name', default="state_diagram", help='name of the plotted diagram file')
+def plot_diagram(path: str, package: str, states: str, plot_name: str):
+    """
+    Plot and store the state diagram of the app in the app directory
+
+    Path is the path to directory containing the app
+
+    Package is the relative path of the subpackage containing the states
+
+    States is a comma seperated list of .py files including the states
+
+    Plot_name is the name of the plotted diagram file
+
+    Example: featurecloud app plot-states /home/my-app mystates --states states.py --plot_name myplot
+    """
+    try:
+        commands.plot_state_diagram(**{k: v for k, v in locals().items() if v})
+    except FCException as e:
+        click.echo(f'Error: {e}')

cvdlink-0.1.1/FeatureCloud/api/cli/controller/commands.py

@@ -0,0 +1,181 @@
+import os
+
+import click
+from FeatureCloud.api.imp.exceptions import FCException
+
+from FeatureCloud.api.imp.controller import commands
+
+
+@click.group("controller")
+def controller() -> None:
+    """Controller start/stop. Obtain general information about the controller."""
+
+
+@controller.command('start')
+@click.argument('name', type=str, default=commands.DEFAULT_CONTROLLER_NAME, nargs=1, required=False)
+@click.option('--port', default=8000, help='Controller port number. Optional parameter (e.g. --port=8000).', required=False)
+@click.option('--data-dir', default='data', help='Controller data directory. Optional parameter (e.g. --data-dir=./data).', required=False)
+@click.option('--controller-image', default="", help='Controller image name (e.g., featurecloud.ai/controller:latest)', required=False)
+@click.option('--gpu', help='Start controller with GPU access. If this succeeds, controller can allow GPU access for apps.', default=False, required=False)
+@click.option('--mount', help='Use this option when you want mount a folder that is available only to the '
+                              'controller\'s protected environment, e.g. to upload input data for apps.', default='', required=False)
+@click.option('--blockchain-address', help='Address of application that connects to the blockchain system', default='', required=False)
+
+# NEW – specific overrides
+@click.option(
+    "--global-endpoint",
+    default="",
+    help="Override manager.globalEndpoint (default taken from config.yml).",
+)
+@click.option(
+    "--registry",
+    default="",
+    help="Override manager.registry (default taken from config.yml).",
+)
+@click.option(
+    "--relay-address",
+    default="",
+    help="Override relay.address (default taken from config.yml).",
+)
+@click.option(
+    "--poll-interval",
+    type=int,
+    default=0,
+    help="Override workflow.pollInterval (default taken from config.yml).",
+)
+@click.option(
+    "--query-interval",
+    type=int,
+    default=0,
+    help="Override workflow.queryInterval (default taken from config.yml).",
+)
+@click.option(
+    "--config-file",
+    default="",
+    help="Path to config file inside container (defaults to config.yml).",
+)
+
+@click.pass_context
+def start(ctx: click.Context,
+          name: str,
+          port: int,
+          data_dir: str,
+          controller_image: str,
+          gpu: bool,
+          mount: str,
+          blockchain_address: str,
+          global_endpoint: str,
+          registry: str,
+          relay_address: str,
+          poll_interval: int,
+          query_interval: int,
+          config_file: str,
+          ) -> None:
+    """Start a controller instance.
+
+    NAME is the controller instance name
+
+    Example: featurecloud controller start my-fc-controller --gpu=True
+    """
+    profile = "featurecloud"
+    if ctx is not None and isinstance(ctx.obj, dict):
+        profile = ctx.obj.get("profile", "featurecloud")
+    try:
+        commands.start(
+            name=name,
+            port=port,
+            data_dir=data_dir,
+            controller_image=controller_image,
+            with_gpu=gpu,
+            mount=mount,
+            blockchain_address=blockchain_address,
+            profile=profile,
+            global_endpoint=global_endpoint,
+            registry=registry,
+            relay_address=relay_address,
+            poll_interval=poll_interval,
+            query_interval=query_interval,
+            config_file=config_file,
+        )
+        click.echo(
+            click.style(
+                f"Started controller '{name}' using profile '{profile}'",
+                fg="green",
+                bold=True,
+            )
+        )
+    except FCException as e:
+        if str(e).find("port is already allocated") > -1:
+            click.echo(f'Controller could not be started. Port {port} is already allocated.')
+        else:
+            click.echo(f'Controller could not be started. Error: {e}')
+
+
+@controller.command('stop')
+@click.argument('name', type=str, default=commands.DEFAULT_CONTROLLER_NAME, nargs=1, required=False)
+def stop(name: str) -> None:
+    """Stop controller instance.
+
+    NAME is the controller instance name
+
+    Example: featurecloud controller stop my-fc-controller
+    """
+
+    try:
+        result = commands.stop(name)
+        if len(result) == 0:
+            click.echo(f'No controller found with name {name}')
+        else:
+            click.echo(f'Stopped controller(s): {",".join(result)}')
+    except FCException as e:
+        click.echo(f'Controller could not be stopped. Error: {e}')
+
+
+@controller.command('logs')
+@click.argument('name', type=str, default=commands.DEFAULT_CONTROLLER_NAME, nargs=1, required=False)
+@click.option('--tail', help='View the tail of controller logs. (e.g. featurecloud controller logs --tail=True)', default=False, required=False)
+@click.option('--log-level', default='debug', help='Log level filter. Will filter more sever errors than specified (e.g. featurecloud controller logs  --log-level=debug).', required=False)
+def logs(name: str, log_level: str, tail: bool) -> None:
+    """Display the logs for the controller instance.
+
+    NAME is the controller instance name.
+
+    Example: featurecloud controller logs my-fc-controller
+    """
+
+    try:
+        for line in commands.logs(name, tail, log_level):
+            click.echo(line)
+    except FCException as e:
+        click.echo(f'Error: {e}')
+
+
+@controller.command('status')
+@click.argument('name', type=str, default=commands.DEFAULT_CONTROLLER_NAME, nargs=1, required=False)
+def status(name: str) -> None:
+    """Display general status of the controller.
+
+    NAME is the controller instance name.
+
+    Example: featurecloud controller status my-fc-controller
+    """
+
+    try:
+        container = commands.status(name)
+        click.echo(f'Id: {container.short_id}, Status: {container.status}')
+    except FCException as e:
+        click.echo(f'Error: {e}')
+
+
+@controller.command('ls')
+def ls() -> None:
+    """Lists all running controller instances"""
+    try:
+        result = commands.ls()
+        if len(result) == 0:
+            click.echo('No controllers found')
+        else:
+            for container in result:
+                click.echo(f'Id: {container.short_id}, Status: {container.status}')
+    except FCException as e:
+        click.echo(f'Error: {e}')