def delete(ctx):
"""Delete project.
Uses /docs/core/cli/#caching
"""
owner, project_name = get_project_or_local(ctx.obj.get("project"),
is_cli=True)
if not click.confirm("Are sure you want to delete project `{}/{}`".format(
owner, project_name)):
click.echo("Existing without deleting project.")
sys.exit(1)
try:
polyaxon_client = ProjectClient(owner=owner, project=project_name)
response = polyaxon_client.delete()
local_project = ProjectManager.get_config()
if local_project and (owner, project_name) == (
local_project.user,
local_project.name,
):
# Purge caching
ProjectManager.purge()
except (ApiException, HTTPError) as e:
handle_cli_error(e,
message="Could not delete project `{}/{}`.".format(
owner, project_name))
sys.exit(1)
if response.status_code == 204:
Printer.print_success("Project `{}/{}` was delete successfully".format(
owner, project_name))
def get(ctx):
"""Get info for current project, by project_name, or owner/project_name.
Uses /docs/core/cli/#caching
Examples:
To get current project:
\b
$ polyaxon project get
To get a project by name
\b
$ polyaxon project get owner/project
"""
owner, project_name = get_project_or_local(ctx.obj.get("project"),
is_cli=True)
try:
polyaxon_client = ProjectClient(owner=owner, project=project_name)
polyaxon_client.refresh_data()
config = polyaxon_client.client.sanitize_for_serialization(
polyaxon_client.project_data)
cache.cache(config_manager=ProjectManager, config=config)
except (ApiException, HTTPError) as e:
handle_cli_error(
e, message="Could not get project `{}`.".format(project_name))
sys.exit(1)
get_project_details(polyaxon_client.project_data)
def ls(owner, limit, offset):
"""List projects.
Uses /docs/core/cli/#caching
"""
owner = owner or AuthConfigManager.get_value("username")
if not owner:
Printer.print_error(
"Please login first or provide a valid owner --owner. "
"`polyaxon login --help`")
sys.exit(1)
try:
polyaxon_client = ProjectClient(owner=owner)
response = polyaxon_client.list(limit=limit, offset=offset)
except (ApiException, HTTPError) as e:
handle_cli_error(e, message="Could not get list of projects.")
sys.exit(1)
meta = get_meta_response(response)
if meta:
Printer.print_header("Projects for current user")
Printer.print_header("Navigation:")
dict_tabulate(meta)
else:
Printer.print_header("No projects found for current user")
objects = list_dicts_to_tabulate(
[o.to_dict() for o in response.results],
humanize_values=True,
exclude_attrs=["uuid", "description"],
)
if objects:
Printer.print_header("Projects:")
dict_tabulate(objects, is_list_dict=True)
def create(ctx, name, description, tags, public, init):
"""Create a new project.
Uses /docs/core/cli/#caching
Example:
\b
$ polyaxon project create --name=cats-vs-dogs --description="Image Classification with DL"
\b
$ polyaxon project create --name=owner/name --description="Project Description"
"""
if not name:
Printer.print_error(
"Please provide a valid name to create a project.",
command_help="project create",
sys_exit=True,
)
owner, project_name = resolve_entity_info(name or ctx.obj.get("project"),
is_cli=True,
entity_name="project")
tags = validate_tags(tags)
if not owner:
Printer.print_error(
"Please provide a valid name with an owner namespace: --name=owner/project."
)
sys.exit(1)
try:
project_config = V1Project(name=project_name,
description=description,
tags=tags,
is_public=public)
polyaxon_client = ProjectClient(owner=owner)
_project = polyaxon_client.create(project_config)
config = polyaxon_client.client.sanitize_for_serialization(_project)
cache.cache(config_manager=ProjectConfigManager, config=config)
except (ApiException, HTTPError) as e:
handle_cli_error(
e, message="Could not create project `{}`.".format(project_name))
sys.exit(1)
Printer.print_success("Project `{}` was created successfully.".format(
_project.name))
click.echo("You can view this project on Polyaxon UI: {}".format(
get_dashboard_url(subpath="{}/{}".format(owner, _project.name))))
if init:
ctx.obj = {}
ctx.invoke(
init_project,
project="{}/{}".format(owner, project_name),
polyaxonignore=True,
)
def create(ctx, name, description, tags, private, init):
"""Create a new project.
Uses /docs/core/cli/#caching
Example:
\b
$ polyaxon project create --project=cats-vs-dogs --description="Image Classification with DL"
\b
$ polyaxon project create --project=owner/name --description="Project Description"
"""
if not name:
Printer.print_error(
"Please login provide a name to create a project.",
command_help="project create",
sys_exit=True,
)
owner, project_name = get_project_or_local(name or ctx.obj.get("project"),
is_cli=True)
owner = owner or settings.AUTH_CONFIG.username
if not owner and (not settings.CLI_CONFIG or settings.CLI_CONFIG.is_ce):
owner = DEFAULT
tags = validate_tags(tags)
if not owner:
Printer.print_error(
"Please login first or provide a valid name with owner --name=owner/project. "
"`polyaxon login --help`")
sys.exit(1)
try:
project_config = V1Project(name=project_name,
description=description,
tags=tags,
is_public=not private)
polyaxon_client = ProjectClient(owner=owner)
_project = polyaxon_client.create(project_config)
config = polyaxon_client.client.sanitize_for_serialization(_project)
cache.cache(config_manager=ProjectConfigManager, config=config)
except (ApiException, HTTPError) as e:
handle_cli_error(
e, message="Could not create project `{}`.".format(project_name))
sys.exit(1)
Printer.print_success("Project `{}` was created successfully.".format(
_project.name))
click.echo("You can view this project on Polyaxon UI: {}".format(
get_dashboard_url(subpath="{}/{}".format(owner, _project.name))))
if init:
ctx.obj = {}
ctx.invoke(init_project, project="{}/{}".format(owner, project_name))
def ls(owner, query, sort, limit, offset):
"""List projects.
Uses /docs/core/cli/#caching
"""
owner = owner or settings.AUTH_CONFIG.username
if not owner and (not settings.CLI_CONFIG or settings.CLI_CONFIG.is_ce):
owner = DEFAULT
if not owner:
Printer.print_error(
"Please login first or provide a valid owner --owner. "
"`polyaxon login --help`")
sys.exit(1)
try:
polyaxon_client = ProjectClient(owner=owner)
response = polyaxon_client.list(limit=limit,
offset=offset,
query=query,
sort=sort)
except (ApiException, HTTPError) as e:
handle_cli_error(e, message="Could not get list of projects.")
sys.exit(1)
meta = get_meta_response(response)
if meta:
Printer.print_header("Projects for current user")
Printer.print_header("Navigation:")
dict_tabulate(meta)
else:
Printer.print_header("No projects found for current user")
objects = list_dicts_to_tabulate(
[o.to_dict() for o in response.results],
humanize_values=True,
exclude_attrs=[
"uuid",
"readme",
"description",
"is_deleted",
"owner",
"user_email",
"teams",
"role",
"settings",
],
)
if objects:
Printer.print_header("Projects:")
dict_tabulate(objects, is_list_dict=True)
def update(ctx, name, description, private):
"""Update project.
Uses [Caching](/references/polyaxon-cli/#caching)
Example:
\b
```bash
$ polyaxon update foobar --description="Image Classification with DL using TensorFlow"
```
\b
```bash
$ polyaxon update mike1/foobar --description="Image Classification with DL using TensorFlow"
```
\b
```bash
$ polyaxon update --tags="foo, bar"
```
"""
owner, project_name = get_project_or_local(ctx.obj.get("project"),
is_cli=True)
update_dict = {}
if name:
update_dict["name"] = name
if description:
update_dict["description"] = description
if private is not None:
update_dict["is_public"] = not private
if not update_dict:
Printer.print_warning(
"No argument was provided to update the project.")
sys.exit(1)
try:
polyaxon_client = ProjectClient(owner=owner)
response = polyaxon_client.update(update_dict)
except (ApiException, HTTPError) as e:
handle_cli_error(
e, message="Could not update project `{}`.".format(project_name))
sys.exit(1)
Printer.print_success("Project updated.")
get_project_details(response)
def update(ctx, _project, name, description, tags, private):
"""Update project.
Uses /docs/core/cli/#caching
Example:
\b
$ polyaxon project update foobar --description="Image Classification with DL using TensorFlow"
\b
$ polyaxon project update mike1/foobar --description="Image Classification with DL using TensorFlow"
\b
$ polyaxon update --tags="foo, bar"
"""
owner, project_name = get_project_or_local(_project
or ctx.obj.get("project"),
is_cli=True)
update_dict = {}
if name:
update_dict["name"] = name
if description:
update_dict["description"] = description
tags = validate_tags(tags)
if tags:
update_dict["tags"] = tags
if private is not None:
update_dict["is_public"] = not private
if not update_dict:
Printer.print_warning(
"No argument was provided to update the project.")
sys.exit(1)
try:
polyaxon_client = ProjectClient(owner=owner)
response = polyaxon_client.update(update_dict)
except (ApiException, HTTPError) as e:
handle_cli_error(
e, message="Could not update project `{}`.".format(project_name))
sys.exit(1)
Printer.print_success("Project updated.")
get_entity_details(response, "Project")
def _read_from_polyaxon_hub(hub: str):
from polyaxon.client import PolyaxonClient, ProjectClient
from polyaxon.env_vars.getters.versioned_entity import get_component_info
from polyaxon.schemas.cli.client_config import ClientConfig
from polyaxon_schemas.constants import DEFAULT_HUB, NO_AUTH
from polyaxon_schemas.lifecycle import V1ProjectVersionKind
owner, component, version = get_component_info(hub)
try:
if owner == DEFAULT_HUB:
config = ClientConfig()
client = PolyaxonClient(
config=config,
token=NO_AUTH,
)
else:
client = PolyaxonClient()
client = ProjectClient(owner=owner, project=component, client=client)
response = client.get_version(
kind=V1ProjectVersionKind.COMPONENT, version=version
)
return _read_from_stream(response.content)
except (ApiException, HTTPError) as e:
raise PolyaxonClientException(
"Component `{}` could not be fetched, "
"an error was encountered".format(hub, e)
)
def create(ctx, name, owner, description, private, init):
"""Create a new project.
Uses /docs/core/cli/#caching
Example:
\b
$ polyaxon project create --name=cats-vs-dogs --description="Image Classification with DL"
"""
owner = owner or AuthConfigManager.get_value("username")
if not owner:
Printer.print_error(
"Please login first or provide a valid owner --owner. "
"`polyaxon login --help`")
sys.exit(1)
try:
project_config = V1Project(name=name,
description=description,
is_public=not private)
_project = ProjectClient(owner=owner).create(project_config)
except (ApiException, HTTPError) as e:
handle_cli_error(e,
message="Could not create project `{}`.".format(name))
sys.exit(1)
Printer.print_success("Project `{}` was created successfully.".format(
_project.name))
if init:
ctx.obj = {}
ctx.invoke(init_project, project=name)
def ls(owner, query, sort, limit, offset):
"""List projects.
Uses /docs/core/cli/#caching
"""
owner = owner or get_local_owner(is_cli=True)
if not owner:
Printer.print_error("Please provide a valid owner: --owner/-o.")
sys.exit(1)
try:
polyaxon_client = ProjectClient(owner=owner)
response = polyaxon_client.list(limit=limit,
offset=offset,
query=query,
sort=sort)
except (ApiException, HTTPError) as e:
handle_cli_error(e, message="Could not get list of projects.")
sys.exit(1)
meta = get_meta_response(response)
if meta:
Printer.print_header("Projects for owner {}".format(owner))
Printer.print_header("Navigation:")
dict_tabulate(meta)
else:
Printer.print_header("No projects found for owner {}".format(owner))
objects = list_dicts_to_tabulate(
[o.to_dict() for o in response.results],
humanize_values=True,
exclude_attrs=[
"uuid",
"readme",
"description",
"owner",
"user_email",
"role",
"settings",
],
)
if objects:
Printer.print_header("Projects:")
dict_tabulate(objects, is_list_dict=True)
def check_project(name: str):
project = ProjectClient(project=name)
try:
project.refresh_data()
except ApiException:
project.project_data.name = 'sgd-classifier'
project.create(project.project_data)
def create(ctx, name, owner, description, tags, private, init):
"""Create a new project.
Uses /docs/core/cli/#caching
Example:
\b
$ polyaxon project create --name=cats-vs-dogs --description="Image Classification with DL"
"""
owner = owner or settings.AUTH_CONFIG.username or DEFAULT
tags = validate_tags(tags)
if not owner:
Printer.print_error(
"Please login first or provide a valid owner --owner. "
"`polyaxon login --help`")
sys.exit(1)
try:
project_config = V1Project(name=name,
description=description,
tags=tags,
is_public=not private)
polyaxon_client = ProjectClient(owner=owner)
_project = polyaxon_client.create(project_config)
config = polyaxon_client.client.sanitize_for_serialization(_project)
cache.cache(config_manager=ProjectManager, config=config)
except (ApiException, HTTPError) as e:
handle_cli_error(e,
message="Could not create project `{}`.".format(name))
sys.exit(1)
Printer.print_success("Project `{}` was created successfully.".format(
_project.name))
if init:
ctx.obj = {}
ctx.invoke(init_project, project=name)
def init(project, git_connection, git_url, polyaxonfile, polyaxonignore):
"""Initialize a new local project and cache directory.
Note: Make sure to add the local cache `.polyaxon`
to your `.gitignore` and `.dockerignore` files.
"""
if not any(
[project, git_connection, git_url, polyaxonfile, polyaxonignore]):
Printer.print_warning(
"`polyaxon init` did not receive any valid option.",
command_help="polyaxon init",
)
if project:
owner, project_name = get_project_or_local(project, is_cli=True)
try:
polyaxon_client = ProjectClient(owner=owner, project=project_name)
polyaxon_client.refresh_data()
except (ApiException, HTTPError) as e:
Printer.print_error(
"Make sure you have a project with this name `{}`".format(
project))
handle_cli_error(
e,
message="You can a create new project with this command: "
"polyaxon project create "
"--name={} [--description=...] [--tags=...]".format(
project_name),
)
sys.exit(1)
init_project = False
if ProjectConfigManager.is_initialized():
local_project = get_local_project()
click.echo(
"Warning! This project is already initialized with the following project:"
)
with indentation.indent(4):
indentation.puts("Owner: {}".format(local_project.owner))
indentation.puts("Project: {}".format(local_project.name))
if click.confirm("Would you like to override this current config?",
default=False):
init_project = True
else:
init_project = True
if init_project:
ProjectConfigManager.purge(
visibility=ProjectConfigManager.VISIBILITY_LOCAL)
config = polyaxon_client.client.sanitize_for_serialization(
polyaxon_client.project_data)
ProjectConfigManager.set_config(
config,
init=True,
visibility=ProjectConfigManager.VISIBILITY_LOCAL)
Printer.print_success("Project was initialized")
Printer.print_header(
"Make sure to add the local cache `.polyaxon` "
"to your `.gitignore` and `.dockerignore` files.")
else:
Printer.print_header("Project config was not changed.")
if git_connection or git_url:
init_git = False
if GitConfigManager.is_initialized():
click.echo("Warning! A {} file was found.".format(
GitConfigManager.CONFIG_FILE_NAME))
if click.confirm("Would you like to override it?", default=False):
init_git = True
else:
init_git = True
if init_git:
GitConfigManager.purge(
visibility=GitConfigManager.VISIBILITY_LOCAL)
config = GitConfigManager.CONFIG(
connection=git_connection,
git=V1GitType(url=git_url) if git_url else None,
)
GitConfigManager.set_config(config=config, init=True)
Printer.print_success("New {} file was created.".format(
GitConfigManager.CONFIG_FILE_NAME))
else:
Printer.print_header("{} file was not changed.".format(
GitConfigManager.CONFIG_FILE_NAME))
if polyaxonfile:
create_polyaxonfile()
if polyaxonignore:
init_ignore = False
if IgnoreConfigManager.is_initialized():
click.echo("Warning! A {} file was found.".format(
IgnoreConfigManager.CONFIG_FILE_NAME))
if click.confirm("Would you like to override it?", default=False):
init_ignore = True
else:
init_ignore = True
if init_ignore:
IgnoreConfigManager.init_config()
Printer.print_success("New {} file was created.".format(
IgnoreConfigManager.CONFIG_FILE_NAME))
else:
Printer.print_header("{} file was not changed.".format(
IgnoreConfigManager.CONFIG_FILE_NAME))
def init(project, polyaxonfile, purge):
"""Initialize a new polyaxonfile specification."""
owner, project_name = get_project_or_local(project, is_cli=True)
try:
polyaxon_client = ProjectClient(owner=owner, project=project_name)
polyaxon_client.refresh_data()
except (ApiException, HTTPError) as e:
Printer.print_error(
"Make sure you have a project with this name `{}`".format(project))
handle_cli_error(
e,
message="You can a create new project with this command: "
"polyaxon project create "
"--name={} [--description=...] [--tags=...]".format(project_name),
)
sys.exit(1)
if purge:
ProjectManager.purge()
IgnoreManager.purge()
init_project = False
if ProjectManager.is_initialized():
local_project = ProjectManager.get_config()
click.echo(
"Warning! This project is already initialized with the following project:"
)
with indentation.indent(4):
indentation.puts("User: {}".format(local_project.user))
indentation.puts("Project: {}".format(local_project.name))
if click.confirm("Would you like to override this current config?",
default=False):
init_project = True
else:
init_project = True
if init_project:
ProjectManager.purge(visibility=ProjectManager.VISIBILITY_LOCAL)
config = polyaxon_client.client.sanitize_for_serialization(
polyaxon_client.project_data)
ProjectManager.set_config(config,
init=True,
visibility=ProjectManager.VISIBILITY_LOCAL)
Printer.print_success("Project was initialized")
else:
Printer.print_header("Project config was not changed.")
init_ignore = False
if IgnoreManager.is_initialized():
click.echo("Warning! Found a .polyaxonignore file.")
if click.confirm("Would you like to override it?", default=False):
init_ignore = True
else:
init_ignore = True
if init_ignore:
IgnoreManager.init_config()
Printer.print_success("New .polyaxonignore file was created.")
else:
Printer.print_header(".polyaxonignore file was not changed.")
if polyaxonfile:
create_polyaxonfile()
create_debug_polyaxonfile()
