Skip to content

Remove tomefile and add formatters to install and uninstall commands #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidsanfal merged 6 commits into from
Apr 1, 2025
Merged

Remove tomefile and add formatters to install and uninstall commands #4

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
49c0a94
wip
czoido Apr 1, 2025
73dce98
wip
czoido Apr 1, 2025
be4f0fd
Merge branch 'main' of github.com:jfrog/tome into czoido/remove-tomefile
czoido Apr 1, 2025
a9b90c2
wip
czoido Apr 1, 2025
48a5dee
wip
czoido Apr 1, 2025
0114632
minor changes
czoido Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
wip
  • Loading branch information
@czoido
czoido committed Apr 1, 2025
commit 73dce98e4181b8dde78b36c9ff87c8aa401de6b5
32 changes: 12 additions & 20 deletions tome/commands/install.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,41 +1,35 @@
import os
import sys
import json
import yaml
from tome.api.output import TomeOutput
from tome.command import tome_command
from tome.errors import TomeException
from tome.internal.source import Source, SourceType


def text_install_formatter(data):
"""Formats the installation summary as plain text."""
output = TomeOutput(stdout=True)
if data.get("installed"):
output.info("Installed sources:")
for origin, message in data["installed"].items():
output.info(f" {origin}: {message}")
if data.get("failed"):
output.warning("Failed sources:")
for origin, error in data["failed"].items():
output.warning(f" {origin}: {error}")
output.info(f"Installed source: {data.get('installed')}")
output.info(f"Message: {data.get('message')}")


def json_install_formatter(data):
"""Formats the installation summary as JSON."""
output = TomeOutput(stdout=True)
output.print_json(json.dumps(data, indent=4))


@tome_command(formatters={"text": text_install_formatter, "json": json_install_formatter})
def install(tome_api, parser, *args):
"""
Install scripts from various sources.
Install scripts from a source.

The source can be a git repository, a folder, or a zip file (local or http).
Editable installations are supported with the -e/--editable flag.
"""
parser.add_argument(
"source",
nargs="?",
help="Source can be a git repository, folder, or zip file (local or http).",
help="Source: a git repository, folder, or zip file (local or http).",
)
parser.add_argument("-e", "--editable", action="store_true", help="Install a package in editable mode.")
parser.add_argument("--no-ssl", action="store_true", help="Do not verify SSL connections.")
Expand All @@ -47,7 +41,7 @@ def install(tome_api, parser, *args):
parser.add_argument(
"--force-requirements",
action="store_true",
help="Install requirements even if not running tome in a virtual environment.",
help="Force installation of requirements even if not running in a virtual environment.",
)
parser.add_argument(
"--folder", help="Specify a folder within the source to install from (only valid for git or zip file sources)."
Expand All @@ -65,18 +59,16 @@ def install(tome_api, parser, *args):

source.verify_ssl = not args.no_ssl

# Prepare a summary dictionary for the installation results
summary = {"installed": {}, "failed": {}}
try:
if args.editable:
source.type = SourceType.EDITABLE
tome_api.install.install_editable(source, args.force_requirements, args.create_env)
summary["installed"][source.uri] = "Editable installation succeeded."
result = {"installed": source.uri, "message": "Editable installation succeeded."}
else:
tome_api.install.install_from_source(source, args.force_requirements, args.create_env)
summary["installed"][source.uri] = "Installation succeeded."
result = {"installed": source.uri, "message": "Installation succeeded."}
except TomeException as e:
TomeOutput().warning(f"Failed to install {source.uri}: {str(e)}")
summary["failed"][source.uri] = str(e)
raise

return summary
return result