proximl 0.5.4__py3-none-any.whl → 0.5.6__py3-none-any.whl

proximl/__init__.py

@@ -13,5 +13,5 @@ logging.basicConfig(
 logger = logging.getLogger(__name__)
 
 
-__version__ = "0.5.4"
+__version__ = "0.5.5"
 __all__ = "ProxiML"

proximl/cli/__init__.py

@@ -142,9 +142,7 @@ def configure(config):
         project for project in projects if project.id == active_project_id
     ]
 
-    active_project_name = (
-        active_project[0].name if len(active_project) else "UNSET"
-    )
+    active_project_name = active_project[0].name if len(active_project) else "UNSET"
 
     click.echo(f"Current Active Project: {active_project_name}")
 
@@ -154,9 +152,7 @@ def configure(config):
         show_choices=True,
         default=active_project_name,
     )
-    selected_project = [
-        project for project in projects if project.name == name
-    ]
+    selected_project = [project for project in projects if project.name == name]
     config.proximl.client.set_active_project(selected_project[0].id)
 
 
@@ -164,6 +160,7 @@ from proximl.cli.connection import connection
 from proximl.cli.dataset import dataset
 from proximl.cli.model import model
 from proximl.cli.checkpoint import checkpoint
+from proximl.cli.volume import volume
 from proximl.cli.environment import environment
 from proximl.cli.gpu import gpu
 from proximl.cli.job import job

proximl/cli/cloudbender/service.py

@@ -0,0 +1,129 @@
+import click
+from proximl.cli import cli, pass_config, search_by_id_name
+from proximl.cli.cloudbender import cloudbender
+
+
+@cloudbender.group()
+@pass_config
+def service(config):
+    """proxiML CloudBender service commands."""
+    pass
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to list services for.",
+)
+@pass_config
+def list(config, provider, region):
+    """List services."""
+    data = [
+        ["ID", "NAME", "HOSTNAME"],
+        [
+            "-" * 80,
+            "-" * 80,
+            "-" * 80,
+        ],
+    ]
+
+    services = config.proximl.run(
+        config.proximl.client.cloudbender.services.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    for service in services:
+        data.append(
+            [
+                service.id,
+                service.name,
+                service.hostname,
+            ]
+        )
+
+    for row in data:
+        click.echo(
+            "{: >25.24} {: >29.28} {: >40.39}" "".format(*row),
+            file=config.stdout,
+        )
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to create the service in.",
+)
+@click.option(
+    "--public/--no-public",
+    default=True,
+    show_default=True,
+    help="Service should be accessible from the public internet.",
+)
+@click.argument("name", type=click.STRING, required=True)
+@pass_config
+def create(config, provider, region, public, name):
+    """
+    Creates a service.
+    """
+    return config.proximl.run(
+        config.proximl.client.cloudbender.services.create(
+            provider_uuid=provider, region_uuid=region, name=name, public=public
+        )
+    )
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to remove the service from.",
+)
+@click.argument("service", type=click.STRING)
+@pass_config
+def remove(config, provider, region, service):
+    """
+    Remove a service.
+
+    RESERVATION may be specified by name or ID, but ID is preferred.
+    """
+    services = config.proximl.run(
+        config.proximl.client.cloudbender.services.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    found = search_by_id_name(service, services)
+    if None is found:
+        raise click.UsageError("Cannot find specified service.")
+
+    return config.proximl.run(found.remove())

proximl/cli/volume.py

@@ -0,0 +1,235 @@
+import click
+from proximl.cli import cli, pass_config, search_by_id_name
+
+
+def pretty_size(num):
+    if not num:
+        num = 0.0
+    s = ("  B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "YiB")
+    n = 0
+    while num > 1023:
+        num = num / 1024
+        n += 1
+    return f"{num:.2f} {s[n]}"
+
+
+@cli.group()
+@pass_config
+def volume(config):
+    """proxiML volume commands."""
+    pass
+
+
+@volume.command()
+@click.argument("volume", type=click.STRING)
+@pass_config
+def attach(config, volume):
+    """
+    Attach to volume and show creation logs.
+
+    VOLUME may be specified by name or ID, but ID is preferred.
+    """
+    volumes = config.proximl.run(config.proximl.client.volumes.list())
+
+    found = search_by_id_name(volume, volumes)
+    if None is found:
+        raise click.UsageError("Cannot find specified volume.")
+
+    try:
+        config.proximl.run(found.attach())
+        return config.proximl.run(found.disconnect())
+    except:
+        try:
+            config.proximl.run(found.disconnect())
+        except:
+            pass
+        raise
+
+
+@volume.command()
+@click.option(
+    "--attach/--no-attach",
+    default=True,
+    show_default=True,
+    help="Auto attach to volume and show creation logs.",
+)
+@click.argument("volume", type=click.STRING)
+@pass_config
+def connect(config, volume, attach):
+    """
+    Connect local source to volume and begin upload.
+
+    VOLUME may be specified by name or ID, but ID is preferred.
+    """
+    volumes = config.proximl.run(config.proximl.client.volumes.list())
+
+    found = search_by_id_name(volume, volumes)
+    if None is found:
+        raise click.UsageError("Cannot find specified volume.")
+
+    try:
+        if attach:
+            config.proximl.run(found.connect(), found.attach())
+            return config.proximl.run(found.disconnect())
+        else:
+            return config.proximl.run(found.connect())
+    except:
+        try:
+            config.proximl.run(found.disconnect())
+        except:
+            pass
+        raise
+
+
+@volume.command()
+@click.option(
+    "--attach/--no-attach",
+    default=True,
+    show_default=True,
+    help="Auto attach to volume and show creation logs.",
+)
+@click.option(
+    "--connect/--no-connect",
+    default=True,
+    show_default=True,
+    help="Auto connect source and start volume creation.",
+)
+@click.option(
+    "--source",
+    "-s",
+    type=click.Choice(["local"], case_sensitive=False),
+    default="local",
+    show_default=True,
+    help="Dataset source type.",
+)
+@click.argument("name", type=click.STRING)
+@click.argument("capacity", type=click.INT)
+@click.argument(
+    "path", type=click.Path(exists=True, file_okay=False, resolve_path=True)
+)
+@pass_config
+def create(config, attach, connect, source, name, capacity, path):
+    """
+    Create a volume.
+
+    A volume with maximum size CAPACITY is created with the specified NAME using a local source at the PATH
+    specified. PATH should be a local directory containing the source data for
+    a local source or a URI for all other source types.
+    """
+
+    if source == "local":
+        volume = config.proximl.run(
+            config.proximl.client.volumes.create(
+                name=name, source_type="local", source_uri=path, capacity=capacity
+            )
+        )
+
+        try:
+            if connect and attach:
+                config.proximl.run(volume.attach(), volume.connect())
+                return config.proximl.run(volume.disconnect())
+            elif connect:
+                return config.proximl.run(volume.connect())
+            else:
+                raise click.UsageError(
+                    "Abort!\n"
+                    "No logs to show for local sourced volume without connect."
+                )
+        except:
+            try:
+                config.proximl.run(volume.disconnect())
+            except:
+                pass
+            raise
+
+
+@volume.command()
+@click.argument("volume", type=click.STRING)
+@pass_config
+def disconnect(config, volume):
+    """
+    Disconnect and clean-up volume upload.
+
+    VOLUME may be specified by name or ID, but ID is preferred.
+    """
+    volumes = config.proximl.run(config.proximl.client.volumes.list())
+
+    found = search_by_id_name(volume, volumes)
+    if None is found:
+        raise click.UsageError("Cannot find specified volume.")
+
+    return config.proximl.run(found.disconnect())
+
+
+@volume.command()
+@pass_config
+def list(config):
+    """List volumes."""
+    data = [
+        ["ID", "STATUS", "NAME", "CAPACITY"],
+        ["-" * 80, "-" * 80, "-" * 80, "-" * 80],
+    ]
+
+    volumes = config.proximl.run(config.proximl.client.volumes.list())
+
+    for volume in volumes:
+        data.append(
+            [
+                volume.id,
+                volume.status,
+                volume.name,
+                volume.capacity,
+            ]
+        )
+    for row in data:
+        click.echo(
+            "{: >38.36} {: >13.11} {: >40.38} {: >14.12}" "".format(*row),
+            file=config.stdout,
+        )
+
+
+@volume.command()
+@click.option(
+    "--force/--no-force",
+    default=False,
+    show_default=True,
+    help="Force removal.",
+)
+@click.argument("volume", type=click.STRING)
+@pass_config
+def remove(config, volume, force):
+    """
+    Remove a volume.
+
+    VOLUME may be specified by name or ID, but ID is preferred.
+    """
+    volumes = config.proximl.run(config.proximl.client.volumes.list())
+
+    found = search_by_id_name(volume, volumes)
+    if None is found:
+        if force:
+            config.proximl.run(found.client.volumes.remove(volume))
+        else:
+            raise click.UsageError("Cannot find specified volume.")
+
+    return config.proximl.run(found.remove(force=force))
+
+
+@volume.command()
+@click.argument("volume", type=click.STRING)
+@click.argument("name", type=click.STRING)
+@pass_config
+def rename(config, volume, name):
+    """
+    Renames a volume.
+
+    VOLUME may be specified by name or ID, but ID is preferred.
+    """
+    try:
+        volume = config.proximl.run(config.proximl.client.volumes.get(volume))
+        if volume is None:
+            raise click.UsageError("Cannot find specified volume.")
+    except:
+        raise click.UsageError("Cannot find specified volume.")
+
+    return config.proximl.run(volume.rename(name=name))

proximl/cloudbender/services.py

@@ -0,0 +1,115 @@
+import json
+import logging
+
+
+class Services(object):
+    def __init__(self, proximl):
+        self.proximl = proximl
+
+    async def get(self, provider_uuid, region_uuid, id, **kwargs):
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service/{id}",
+            "GET",
+            kwargs,
+        )
+        return Service(self.proximl, **resp)
+
+    async def list(self, provider_uuid, region_uuid, **kwargs):
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service",
+            "GET",
+            kwargs,
+        )
+        services = [Service(self.proximl, **service) for service in resp]
+        return services
+
+    async def create(
+        self,
+        provider_uuid,
+        region_uuid,
+        name,
+        public,
+        **kwargs,
+    ):
+        logging.info(f"Creating Service {name}")
+        data = dict(
+            name=name,
+            public=public,
+            **kwargs,
+        )
+        payload = {k: v for k, v in data.items() if v is not None}
+        resp = await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service",
+            "POST",
+            None,
+            payload,
+        )
+        service = Service(self.proximl, **resp)
+        logging.info(f"Created Service {name} with id {service.id}")
+        return service
+
+    async def remove(self, provider_uuid, region_uuid, id, **kwargs):
+        await self.proximl._query(
+            f"/provider/{provider_uuid}/region/{region_uuid}/service/{id}",
+            "DELETE",
+            kwargs,
+        )
+
+
+class Service:
+    def __init__(self, proximl, **kwargs):
+        self.proximl = proximl
+        self._service = kwargs
+        self._id = self._service.get("service_id")
+        self._provider_uuid = self._service.get("provider_uuid")
+        self._region_uuid = self._service.get("region_uuid")
+        self._public = self._service.get("public")
+        self._name = self._service.get("name")
+        self._hostname = self._service.get("hostname")
+
+    @property
+    def id(self) -> str:
+        return self._id
+
+    @property
+    def provider_uuid(self) -> str:
+        return self._provider_uuid
+
+    @property
+    def region_uuid(self) -> str:
+        return self._region_uuid
+
+    @property
+    def public(self) -> bool:
+        return self._public
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def hostname(self) -> str:
+        return self._hostname
+
+    def __str__(self):
+        return json.dumps({k: v for k, v in self._service.items()})
+
+    def __repr__(self):
+        return f"Service( proximl , **{self._service.__repr__()})"
+
+    def __bool__(self):
+        return bool(self._id)
+
+    async def remove(self):
+        await self.proximl._query(
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/service/{self._id}",
+            "DELETE",
+        )
+
+    async def refresh(self):
+        resp = await self.proximl._query(
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/service/{self._id}",
+            "GET",
+        )
+        self.__init__(self.proximl, **resp)
+        return self

proximl/exceptions.py

@@ -97,14 +97,27 @@ class CheckpointError(ProxiMLException):
         return self._status
 
     def __repr__(self):
-        return "CheckpointError({self.status}, {self.message})".format(
-            self=self
-        )
+        return "CheckpointError({self.status}, {self.message})".format(self=self)
 
     def __str__(self):
-        return "CheckpointError({self.status}, {self.message})".format(
-            self=self
-        )
+        return "CheckpointError({self.status}, {self.message})".format(self=self)
+
+
+class VolumeError(ProxiMLException):
+    def __init__(self, status, data, *args):
+        super().__init__(data, *args)
+        self._status = status
+        self._message = data
+
+    @property
+    def status(self) -> str:
+        return self._status
+
+    def __repr__(self):
+        return "VolumeError({self.status}, {self.message})".format(self=self)
+
+    def __str__(self):
+        return "VolumeError({self.status}, {self.message})".format(self=self)
 
 
 class ConnectionError(ProxiMLException):
@@ -130,11 +143,7 @@ class SpecificationError(ProxiMLException):
         return self._attribute
 
     def __repr__(self):
-        return "SpecificationError({self.attribute}, {self.message})".format(
-            self=self
-        )
+        return "SpecificationError({self.attribute}, {self.message})".format(self=self)
 
     def __str__(self):
-        return "SpecificationError({self.attribute}, {self.message})".format(
-            self=self
-        )
+        return "SpecificationError({self.attribute}, {self.message})".format(self=self)