viur-cli 2.0.2__tar.gz → 2.1.0.dev1__tar.gz

{viur_cli-2.0.2/src/viur_cli.egg-info → viur_cli-2.1.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: viur_cli
-Version: 2.0.2
+Version: 2.1.0.dev1
 Summary: Command-line interface for ViUR application maintenance.
 Home-page: https://github.com/viur-framework/viur-cli
 Author: Andreas H. Kelch
@@ -194,6 +194,12 @@ It contains the default viur project profile and it can be expanded with several
                 "kind": "npm",
                 "source": ""
             }
+            /* OPTIONAL arguments, can be set in default or in a specific profile */
+            "appyaml": "app_stub.yaml",  // Use a name other than "app.yaml"
+            "appyaml_substitition": true,  // Set to true to replace only standard variables in app.yaml
+            "appyaml_substitition": {  // Set to an object to replace these in addition to the standard variables in app.yaml
+                "$REGION": "europe-west3"
+            }
         },
         "gcloud": {
             "functions": { //Declarations for a cloud function

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/README.md

@@ -174,6 +174,12 @@ It contains the default viur project profile and it can be expanded with several
                 "kind": "npm",
                 "source": ""
             }
+            /* OPTIONAL arguments, can be set in default or in a specific profile */
+            "appyaml": "app_stub.yaml",  // Use a name other than "app.yaml"
+            "appyaml_substitition": true,  // Set to true to replace only standard variables in app.yaml
+            "appyaml_substitition": {  // Set to an object to replace these in addition to the standard variables in app.yaml
+                "$REGION": "europe-west3"
+            }
         },
         "gcloud": {
             "functions": { //Declarations for a cloud function

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/setup.cfg

@@ -32,7 +32,6 @@ where = src
 [options.entry_points]
 console_scripts = 
 	viur = viur_cli:cli
-	viur-2to3 = viur_cli.scripts.viur_2to3:main
 	get-pyodide = viur_cli.scripts.get_pyodide:main
 
 [egg_info]

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli/cloud.py

@@ -1,7 +1,9 @@
 import json
+from pathlib import Path
 import subprocess
 import os
 import string
+import time
 import click
 import yaml
 from viur_cli import echo_positive, echo_warning, echo_fatal
@@ -15,6 +17,53 @@ def cloud():
     """This method defines a command group for working with cloud resources."""
 
 
+@cloud.command(context_settings={"ignore_unknown_options": True})
+@click.argument("action", type=click.Choice(["bucket2bucket", "bucket2local", "local2bucket"]))
+@click.argument("profile", default="default")
+def copy(action, profile):
+    if action == "bucket2bucket":
+        if user_check_login():
+            storage_copy()
+
+    if action == "bucket2local":
+        if user_check_login():
+            datastore_import(profile)
+
+    if action == "local2bucket":
+        if user_check_login():
+            datastore_export(profile)
+
+
+def user_check_login():
+    return click.confirm("Are you logged in with your gcloud admin account?", default=False, show_default=True)
+
+
+def storage_copy():
+    # https://console.cloud.google.com/transfer/jobs
+    source = click.prompt('Source bucketname')
+    target = click.prompt('Target bucketname')
+    if not click.confirm(text=f"Copy from {source} to {target}", default=True):
+        print("Abort ...")
+        return 0
+    print(f"gsutil -m cp -r gs://{source}/ gs://{target}/")
+    os.system(f"gsutil -m cp -r gs://{source} gs://{target}")
+
+
+def datastore_import(profile):
+    conf = config.get_profile(profile)
+    target = click.prompt('path to overall_export_metadata')
+    os.system(f"gcloud datastore import gs://{target} --project={conf['application_name']}")
+
+
+def datastore_export(profile):
+    conf = config.get_profile(profile)
+    target = click.prompt('bucketname')
+    timestamp = f'{datetime.now().strftime("%Y%m%d-%H%M%S")}-manual'
+    format = "default"
+    os.system(
+        f"gcloud datastore export gs://{target}/{timestamp}-{format} --format={format} --project={conf['application_name']} ")
+
+
 @cloud.command(context_settings={"ignore_unknown_options": True})
 @click.argument("action", type=click.Choice(["backup"]))
 def enable(action):
@@ -196,15 +245,19 @@ def disable_gcp_backup():
 
 
 @cloud.command(context_settings={"ignore_unknown_options": True})
-@click.argument("action", type=click.Choice(["gcloud", "gcroles"]))
+@click.argument("action", type=click.Choice(["gcroles"]))
 @click.argument("profile", default="default")
 def setup(action, profile):
     """
     Set up the specified action for the given profile.
     """
     if action == "gcloud":
-        gcloud_setup()
-
+        if os.path.exists('deploy'):
+            gcloud_setup()
+        else:
+            echo_error("No 'deploy' directory found in your current working directory."
+                       "\n Please make sure you are in the correct directory."
+                       "\n If you want to create a new ViUR Project use 'viur create {name}'")
     if action == "gcroles":
         gcloud_setup_roles(profile)
 
@@ -366,121 +419,6 @@ def transform_dict_to_yaml(transformed_data):
     return original_data
 
 
-def gcloud_setup():
-    """
-    Set up the Google Cloud Platform (GCP) environment for a ViUR project.
-
-    This method performs the following steps:
-    1. Prompts the user to enter the GCP project ID.
-    2. Checks if the user is authorized with gcloud.
-       - If not authorized, prompts the user to authenticate with gcloud and login.
-    3. Checks if the GCP App Engine app already exists.
-       - If not, prompts the user to create the app and confirm the project is connected to a billing account.
-    4. Enables necessary APIs and services for the project.
-    5. Configures Google Cloud Storage for the project.
-    6. Deploys necessary deployment files (cron.yaml, queue.yaml, index.yaml) to the project.
-    7. Checks if the app engine default credentials are set.
-       - If not set, prompts the user to authenticate and set the application default user.
-    8. Prints a success message with instructions on how to run the project locally.
-
-    Note: This method does not return anything.
-    """
-    project = input("Enter PROJECT_ID: ").strip()
-
-    if not project:
-        echo_fatal("Usage: viur setup gcloud PROJECT_ID")
-        return
-
-    echo_info("Check if user is authorized with gcloud....")
-
-    try:
-        run_command("gcloud auth print-access-token")
-    except subprocess.CalledProcessError:
-        echo_warning(
-            "##############################################################\n"
-            "# Please authenticate your Google user with gcloud SDK to    #\n"
-            "# execute administrative commands.                           #\n"
-            "# In this step, a separate browser window opens to           #\n"
-            "# authenticate.                                              #\n"
-            "# This step is only required once on this computer.          #\n"
-            "##############################################################\n"
-        )
-        response = input("Are you ready?[Y/n]")
-        if not response.lower() in ("y", ""):
-            echo_fatal("User aborted")
-            return
-
-        run_command("gcloud auth login --no-ptomote")
-
-    # Check if App already exists
-    try:
-        run_command(f"gcloud app describe --project={project}")
-    except subprocess.CalledProcessError:
-        echo_warning(
-            "##############################################################\n"
-            "# Please check and confirm that your project is created and  #\n"
-            "# connected with a billing account in Google Cloud console.  #\n"
-            "# Otherwise, some of the following calls may fail.           #\n"
-            "##############################################################"
-        )
-        response = input("Continue? [Y/n] ")
-        if not response.lower() in ("y", ""):
-            echo_error("User aborted.")
-            return
-
-        # Create the Appengine app
-        run_command(f"gcloud app create --project={project} --region=europe-west3")
-
-    # Activate APIs and Services
-    services = [
-        "datastore.googleapis.com",
-        "firestore.googleapis.com",
-        "iamcredentials.googleapis.com",
-        "cloudbuild.googleapis.com",
-        "cloudtasks.googleapis.com",
-        "cloudscheduler.googleapis.com",
-        "secretmanager.googleapis.com"
-    ]
-
-    for service in services:
-        run_command(f"gcloud services enable --project={project} {service}")
-
-        # Configure Google Cloud Storage
-    run_command(f"gsutil uniformbucketlevelaccess set on gs://{project}.appspot.com/")
-
-    for yaml in ["cron.yaml", "queue.yaml", "index.yaml"]:
-        run_command(f"cd deploy && gcloud app deploy -q --project={project} {yaml}")
-
-    echo_info("Check if app engine default credentials are set...")
-    try:
-        run_command("gcloud auth application-default print-access-token")
-
-    except subprocess.CalledProcessError:
-        echo_warning(
-            "##############################################################\n"
-            "# Please authenticate your Google user with gcloud SDK now   #\n"
-            "# to set the application default user. This step is required #\n"
-            "# to run ViUR applications locally without further           #\n"
-            "# credentials that must be supplied from a file.             #\n"
-            "# This step is only required once on this computer.          #\n"
-            "##############################################################")
-        response = input("Are you ready? [Y/n] ")
-        if not response.lower() in ("y", ""):
-            echo_fatal("User aborted.")
-            return
-
-        run_command("gcloud auth application-default login")
-
-    echo_positive(
-        "All done!\n"
-        "You should now be able to run your project locally with\n"
-        "   viur run \n"
-        "At the first run, it might happen that some functions are\n"
-        "causing error 500 because indexes are not immediately\n"
-        "served. Therefore, maybe wait a few minutes.\n"
-        "Have a nice day.\n")
-
-
 # Helper function for running Commands in subprocess and getting the Output
 def run_command(command):
     """
@@ -501,20 +439,23 @@ def run_command(command):
 @click.argument("additional_args", nargs=-1)
 @click.option("--ext", "-e", default=None)
 @click.option("--yes", "-y", is_flag=True, default=False)
+@click.option("--skip_checks", is_flag=True, help="Skip the security checks before the deployment")
 @click.option("--name", "-n", default=None)
-def deploy(action, profile, name, ext, yes, additional_args):
-    """ Deploy the specified action to a cloud service."""
+def deploy(action, profile, name, ext, yes, skip_checks: bool, additional_args):
+    """Deploy the specified action to a cloud"""
 
     conf = config.get_profile(profile)
 
     if action == "app":
-        from . import do_checks
-        if not do_checks(dev=False):
-            # --yes will not be implemented here because deploying security issues should be an explicit decission
-            if not click.confirm(f"The checks were not successful, do you want to continue?"):
-                return
-        else:
-            echo_info("\U00002714 No vulnerabilities found.")
+        if not skip_checks:
+            from . import do_checks
+            if not do_checks(dev=False):
+                # --yes will not be implemented here because deploying security issues should be an explicit decission
+                if not click.confirm(f"The checks were not successful, do you want to continue?"):
+                    return
+            else:
+                echo_info("\U00002714 No vulnerabilities found.")
+                
         version = replace_vars(
             conf["version"],
             {k: v for k, v in conf.items() if k not in ["version"]}
@@ -529,10 +470,46 @@ def deploy(action, profile, name, ext, yes, additional_args):
         # rebuild requirements.txt
         create_req(yes, profile, confirm_value=False)
 
-        os.system(
-            f'gcloud app deploy --project={conf["application_name"]} --version={version} '
-            f'--no-promote {" ".join(additional_args)} {conf["distribution_folder"]} {"-q" if yes else ""}'
-        )
+        app_yaml = Path(conf["distribution_folder"]) / conf.get("appyaml", "app.yaml")
+        app_yaml_tmp = app_yaml_hidden = None
+        if appyaml_substitition := conf.get("appyaml_substitition"):
+            app_yaml_tmp = app_yaml.with_stem(f"app{time.time_ns()}.tmp")
+
+            susbtitutions = {
+                "$PROJECT_ID": conf["application_name"],
+                "$PROJECT_VERSION": version,
+                "$CLI_PROFILE": profile,
+            }
+            if isinstance(appyaml_substitition, dict):
+                susbtitutions |= appyaml_substitition
+
+            new_content = app_yaml.read_text()
+            for pattern, replacment in susbtitutions.items():
+                new_content = new_content.replace(pattern, replacment)
+            app_yaml_tmp.write_text(new_content)
+            additional_args = [f"--appyaml={app_yaml_tmp.resolve()}", *additional_args]
+
+            # Sadly the --appyaml does only work if the deploy dir does not contain an app.yaml,
+            # thefore we make it "hidden" for the gcloud CLI if there is "app.yaml" is not
+            # named differently
+            if app_yaml.name == "app.yaml":
+                app_yaml_hidden = app_yaml.with_stem(f".{app_yaml.stem}")
+                app_yaml.rename(app_yaml_hidden)
+
+        elif app_yaml.name != "app.yaml":
+            # No substitution is used, but an different app.yaml name
+            additional_args = [f"--appyaml={app_yaml_tmp.resolve()}", *additional_args]
+
+        try:
+            os.system(
+                f'gcloud app deploy --project={conf["application_name"]} --version={version} '
+                f'--no-promote {" ".join(additional_args)} {conf["distribution_folder"]} {"-q" if yes else ""}'
+            )
+        finally:
+            if app_yaml_tmp is not None:
+                app_yaml_tmp.unlink()
+            if app_yaml_hidden is not None:
+                app_yaml_hidden.rename(app_yaml)
 
     elif action == "cloudfunction":
         os.system(build_deploy_command(name, conf["gcloud"]))
@@ -594,7 +571,6 @@ def deploy(action, profile, name, ext, yes, additional_args):
             f'gcloud app deploy --project={conf["application_name"]} {" ".join(additional_args)} {yaml_file} {"-q" if yes else ""}')
 
 
-
 def build_deploy_command(name, conf):
     """
 
@@ -627,9 +603,8 @@ def build_deploy_command(name, conf):
         echo_fatal(f"The cloudfunction {name} was not found your project.json\n "
                    f"You can create a cloudfunction entry by calling 'viur cloud create function'")
 
-
     command = (
-        f"gcloud functions deploy "
+        f"gcloud run deploy "
         f"{name} "
         f"--region='{conf['region']}'"
         f"--max-instances={conf['max-instances']}"
@@ -676,10 +651,10 @@ def create(profile, action, gen, source, name, entrypoint, env_vars_file, memory
         function_dict = conf["gcloud"]["functions"].get(function_name, {})
 
         function_dict["gen"] = function_dict.get("gen",
-                                                        gen if gen else click.prompt(
-                                                            "Please enter your cloud function generation",
-                                                            default="2")
-                                                        )
+                                                 gen if gen else click.prompt(
+                                                     "Please enter your cloud function generation",
+                                                     default="2")
+                                                 )
 
         function_dict["entry-point"] = function_dict.get("entry-point",
                                                          entrypoint if entrypoint else click.prompt(
@@ -708,12 +683,13 @@ def create(profile, action, gen, source, name, entrypoint, env_vars_file, memory
         function_dict["trigger"] = function_dict.get("trigger",
                                                      trigger if trigger else click.prompt(
                                                          "Please enter your cloud function trigger type",
-                                                         default="http")
+                                                         default="https")
+
                                                      )
 
         function_dict["source"] = function_dict.get("source",
                                                     source if source else click.prompt(
-                                                        "Enter the directory of your cloud functio"
+                                                        "Enter the directory of your cloud function"
                                                         "(deploy/cloudfunction/{FileName})")
                                                     )
 
@@ -722,4 +698,5 @@ def create(profile, action, gen, source, name, entrypoint, env_vars_file, memory
         config[profile] = conf
         config.migrate()
         echo_positive("Your cloud function creation was successful, if you want to add more flags, "
-                      "add them in your project.json under")
+                      "add them in your project.json")
+

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli/conf.py

@@ -17,7 +17,7 @@ class ProjectConfig(dict):
         super().__init__()
         self["default"] = {}
         self["format"] = PROJECT_CONFIG_VERSION
-        self.load()
+        self.initial_load = False
 
     def load(self):
         """
@@ -72,21 +72,16 @@ class ProjectConfig(dict):
 
     def get_profile(self, profile):
         """Get profile configuration"""
+        if not self.initial_load:
+            self.load()
+            self.initial_load = True
+
         if profile == "format":
             echo_fatal("Your profile can not be named 'Format' ")
         if profile not in self:
             echo_fatal(f"{profile!r} is not a valid profile name")
         return self["default"].copy() | self[profile]
 
-    def delete(self):
-        """Delete profile cofniguration"""
-        configname = click.prompt('name')
-        try:
-            del self[configname]
-            self.save()
-        except:
-            raise click.ClickException(click.style(f"{configname} not found", fg="red"))
-
     def find_key(self, dictionary, target_key, target, keep=False):
         if target_key in dictionary:
             if keep:
@@ -122,7 +117,7 @@ class ProjectConfig(dict):
             self.find_key(self, target_key="version", target="default", keep=True)
             # Fail Safe
             if "version" in self:
-                del self["version"]  4
+                del self["version"]
         self.remove_key(self, target_key="core")
 
         if old_format := self["default"].get("format"):
@@ -167,8 +162,6 @@ class ProjectConfig(dict):
             format_version_updated = False
 
         for entry in ("admin", "scriptor", "vi"):
-            if not self["default"]["builds"]:
-                self["default"]["builds"]
             if entry in self["default"]:
                 version_value = self["default"][entry].lstrip("v")
                 self["default"]["builds"][entry] = {

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli/local.py

@@ -46,6 +46,13 @@ def run(profile, additional_args):
                    f"Please install the 'gcloud' tool or Log in with an appropriate account.")
 
     conf = config.get_profile(profile)
+    additional_args = list(additional_args)
+
+    if conf.get("port"):
+        additional_args.append(f"--port={conf['port']}")
+    if conf.get("gunicorn_port"):
+        additional_args.append(f"--gunicorn_port={conf['gunicorn_port']}")
+        
     utils.system(
         f'app_server -A={conf["application_name"]} {conf["distribution_folder"]} {" ".join(additional_args)}')
 

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli/package.py

@@ -85,12 +85,13 @@ def get_version_info(software: str, version: str) -> tuple[str, str]:
 @cli.command()
 @click.argument('operation', type=click.Choice(['update', 'install']))
 @click.argument('component', type=click.Choice(['vi', 'admin', 'scriptor', 'all']))
-@click.argument('profile', default='default')
 @click.argument("version", default="latest")
+@click.argument('profile', default='default')
 def package(operation, component, profile, version):
     """
     Performs installements and updates of ViUR Ecosystem packages
     """
+
     conf = config.get_profile(profile)
     operations_links = {
         'vi': vi,
@@ -141,6 +142,13 @@ def scriptor(version, target, profile):
 
     real_version, download_url = get_version_info("scriptor", version)
 
+    old_version=conf.get('builds').get('scriptor').get('version')
+
+    if old_version == real_version.strip("v"):
+        if not click.confirm(f"You have already installed version {old_version} of scriptor.\n"
+                             f"Do you want to continue and install it again?"):
+            return
+
     scriptor_path = Path(dist_folder, target)
     tmp_zip_file = Path("scriptor.zip")
 
@@ -168,6 +176,7 @@ def scriptor(version, target, profile):
                     tmp_zip_file.unlink()
                     bar.label = "updated successful"
 
+    echo_positive(f"Updated scriptor from {old_version} to {real_version}")
 
 def admin(version: str, target: str, profile):
     """Update the admin to a specific version."""
@@ -176,6 +185,13 @@ def admin(version: str, target: str, profile):
 
     real_version, download_url = get_version_info("admin", version)
 
+    old_version=conf.get('builds').get('admin').get('version')
+
+    if old_version == real_version.strip("v"):
+        if not click.confirm(f"You have already installed the version {old_version} of admin.\n"
+                             f"Do you want to continue and install it again?"):
+            return
+
     admin_path = Path(dist_folder, target)
     tmp_zip_file = Path("vi-admin.zip")
 
@@ -207,6 +223,8 @@ def admin(version: str, target: str, profile):
                 tmp_zip_file.unlink()
                 bar.label = "updated successful"
 
+    echo_positive(f"Updated admin from {old_version} to {real_version}")
+
 
 def vi(version, target, profile):
     """Updates Vi to the specified version."""
@@ -215,6 +233,12 @@ def vi(version, target, profile):
     dist_folder = conf["distribution_folder"]
 
     real_version, download_url = get_version_info("vi", version)
+    old_version = conf.get('builds').get('vi').get('version')
+
+    if old_version == real_version.strip("v"):
+        if not click.confirm(f"You have already installed the version {old_version} of vi.\n"
+                             f"Do you want to continue and install it again?"):
+            return
 
     vi_path = Path(dist_folder, target)
     tmp_zip_file = Path("vi.zip")
@@ -246,3 +270,5 @@ def vi(version, target, profile):
             elif element == 5:
                 tmp_zip_file.unlink()
                 bar.label = "updated successful"
+
+    echo_positive(f"Updated Vi from {old_version} to {real_version}")

viur_cli-2.1.0.dev1/src/viur_cli/setup.py

@@ -0,0 +1,110 @@
+import os
+import subprocess
+import click
+from .cli import cli
+from .utils import *
+
+
+def clean_base(app_id, author=None):
+    """
+    Sets up a clean ViUR project base.
+
+    Args:
+        clean_history (bool, optional): Whether to clean the git history. Defaults to True.
+        app_id (str, optional): The application-id to use. If not provided, prompts the user.
+        author (str, optional): The author's name to use. If not provided, defaults to the current user.
+    """
+
+    try:
+        whoami = getpass.getuser()
+    except Exception:
+        whoami = "viur"
+
+    timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+    os.chdir(app_id)
+
+    file_list = ["viur-project.md"]
+    replacements = {"{{app_id}}": app_id, "{{whoami}}": whoami, "{{timestamp}}": timestamp}
+
+    for subdir, dirs, files in os.walk("."):
+        for file in files:
+            filepath = subdir + os.sep + file
+
+            if any([filepath.endswith(ext) for ext in
+                    [".py", ".yaml", ".html", ".md", ".sh", ".json", ".js", ".less"]]):
+                file_list.append(filepath)
+
+    for file_obj in file_list:
+        lines = []
+        with open(file_obj, "r") as infile:
+            for line in infile:
+                for src, target in replacements.items():
+                    line = line.replace(src, target)
+                lines.append(line)
+        with open(file_obj, "w") as outfile:
+            for line in lines:
+                outfile.write(line)
+
+    if os.path.exists(".git"):
+        echo_info("Cleaning git history")
+        subprocess.check_output("git checkout --orphan main_tmp", shell=True)
+        echo_info(subprocess.check_output("git branch -D main", shell=True).decode().rstrip("\n"))
+
+        subprocess.check_output("git branch -m main", shell=True)
+        branch_current = subprocess.check_output('git branch --show-current', shell=True).decode().rstrip('\n')
+        echo_info(f"Current branch is: {branch_current}")
+        echo_info("---")
+
+    echo_info("Generating project documentation...")
+    sys.stdout.flush()
+
+    os.remove("README.md")  # Remove README.md if it exists
+    os.rename("viur-project.md", "README.md")
+    os.remove(sys.argv[0])  # Remove the script itself
+
+    echo_positive("Project repository has been set-up now.")
+
+
+@cli.command()
+@click.argument("name")
+@click.pass_context
+def create(ctx, name):
+    """
+    Create a new ViUR project.
+
+    The 'create' command allows you to create a new ViUR project by cloning the ViUR base project and configuring it.
+    You can specify the name of the new project as the 'name' argument.
+
+    The 'create' command performs the following steps:
+
+        1. Clones the ViUR base project from the official GitHub repository.
+
+        2. Configures the new project by running 'clean-base.py'.
+
+        3. Optionally configures the project as a new gcloud project (if confirmed).
+
+    Note:
+
+        - This command initializes the new ViUR project based on the ViUR base project.
+
+        - Make sure to provide a unique project name to avoid conflicts with existing folders.
+
+    """
+    if os.path.exists(f'./{name}'):
+        echo_error(f'"{name}" Folder already exists. Please use a different name or remove this folder ./{name}')
+        return
+
+    # fetch base project
+    git_clonne_cmd = ['git', 'clone', f'https://github.com/viur-framework/viur-base.git', name]
+    subprocess.run(git_clonne_cmd, check=True)
+
+    wdir = f"{os.getcwd()}/{name}"
+
+    # Run clean-base.py
+    clean_base_cmd = ['python3', 'clean-base.py', '-A', f'{name}']
+    subprocess.run(clean_base_cmd, check=True, cwd=wdir)
+
+    # Run gcloud config (if confirmed)
+    if click.confirm(f'Do you want to configure "{name}" as a new gcloud project?'):
+        gcloud_setup_cmd = ['./viur-gcloud-setup.sh', name]
+        subprocess.run(gcloud_setup_cmd, check=True, cwd=wdir)

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli/tool.py

@@ -1,114 +1,80 @@
-import click
-import os
-
-from . import cli
-
-
-@cli.group()
-def tool():
-    """
-    Run different ViUR-related scripts.
-
-    The 'tool' group allows you to execute various ViUR-related scripts that help with tasks such as project porting,
-    Pyodide installation, and SSL certificate fixes.
-
-    Available Commands:
-
-        - '2to3': ViUR porting script.
-
-        - 'pyodide': Run the get_pyodide command.
-
-        - 'ssl_fix': SSL certificate fix for macOS.
-    """
-
-
-@tool.command(name="2to3")
-@click.argument("path")
-@click.option('--dryrun', '-d', is_flag=True, default=False)
-@click.option('--daredevil', '-x', is_flag=True, default=False)
-def two_to_three(path, *args, **kwargs):
-    """
-    ViUR2 to ViUR3 porting script.
-
-    The '2to3' command allows you to port an existing ViUR2 project to ViUR3. This script is used for
-    migrating projects from Python 2 to Python 3.
-
-    :param path: str
-        The path to the project to be ported.
-    :param dryrun: bool, optional
-        Perform a dry run to test the porting process (default: False).
-    :param daredevil: bool, optional
-        Use the daredevil mode for porting (default: False).
-
-    Example Usage:
-    ```
-    viur tool 2to3 /path/to/project
-    ```
-
-    :return: None
-    """
-    command = f"viur-2to3 {path}"
-    for option, value in kwargs.items():
-        if value:
-            command += f" --{option}"
-
-    os.system(command)
-
-@tool.command()
-@click.option('--version', '-v')
-@click.option('--package', '-p')
-@click.option('--target', '-t')
-@click.option('--help', '-h')
-def pyodide(additional_args, version, package, target, help):
-    """
-    The 'pyodide' command allows you to run the 'get_pyodide' command for Pyodide installation.
-
-    :param additional_args: tuple
-        Additional arguments to pass to the 'get_pyodide' command.
-    :param version: str, optional
-        Specify the version of Pyodide.
-    :param package: str, optional
-        Specify the package for Pyodide.
-    :param target: str, optional
-        Specify the target for Pyodide.
-    :param help: bool, optional
-        Display help for the 'get_pyodide' command.
-
-    Example Usage:
-    ```
-    viur tool pyodide -v 0.19.1 -p mypackage -t mytarget
-    ```
-
-    :return: None
-    """
-    command = "get-pyodide"
-    if help:
-        os.system("get-pyodide -h")
-
-    if version:
-        command += f" -v {version}"
-
-    if package:
-        command += f" -p {package}"
-
-    if target:
-        command += f" -t {target}"
-
-    os.system(command)
-
-
-@tool.command()
-def ssl_fix():
-    """
-    SSL certificate fix for macOS.
-
-    The 'ssl_fix' command is used to perform an SSL certificate fix for macOS.
-
-    Example Usage:
-    ```
-    viur tool ssl_fix
-    ```
-
-    :return: None
-    """
-    os.system("chmod +x scripts/macos_certificate_fix.command && ./scripts/macos_certificate_fix.command")
+import click
+import os
+
+from . import cli
+
+
+@cli.group()
+def tool():
+    """
+    Run different ViUR-related scripts.
+
+    The 'tool' group allows you to execute various ViUR-related scripts that help with tasks such as project porting,
+    Pyodide installation, and SSL certificate fixes.
+
+    Available Commands:
+
+        - 'pyodide': Run the get_pyodide command.
+
+        - 'ssl_fix': SSL certificate fix for macOS.
+    """
+
+
+@tool.command()
+@click.option('--version', '-v')
+@click.option('--package', '-p')
+@click.option('--target', '-t')
+@click.option('--help', '-h')
+def pyodide(additional_args, version, package, target, help):
+    """
+    The 'pyodide' command allows you to run the 'get_pyodide' command for Pyodide installation.
+
+    :param additional_args: tuple
+        Additional arguments to pass to the 'get_pyodide' command.
+    :param version: str, optional
+        Specify the version of Pyodide.
+    :param package: str, optional
+        Specify the package for Pyodide.
+    :param target: str, optional
+        Specify the target for Pyodide.
+    :param help: bool, optional
+        Display help for the 'get_pyodide' command.
+
+    Example Usage:
+    ```
+    viur tool pyodide -v 0.19.1 -p mypackage -t mytarget
+    ```
+
+    :return: None
+    """
+    command = "get-pyodide"
+    if help:
+        os.system("get-pyodide -h")
+
+    if version:
+        command += f" -v {version}"
+
+    if package:
+        command += f" -p {package}"
+
+    if target:
+        command += f" -t {target}"
+
+    os.system(command)
+
+
+@tool.command()
+def ssl_fix():
+    """
+    SSL certificate fix for macOS.
+
+    The 'ssl_fix' command is used to perform an SSL certificate fix for macOS.
+
+    Example Usage:
+    ```
+    viur tool ssl_fix
+    ```
+
+    :return: None
+    """
+    os.system("chmod +x scripts/macos_certificate_fix.command && ./scripts/macos_certificate_fix.command")

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli/version.py

@@ -1,3 +1,3 @@
-__version__ = "2.0.2"
+__version__ = "2.1.0.dev1"
 MINIMAL_PIPENV = "2023.11.15"
 

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1/src/viur_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: viur_cli
-Version: 2.0.2
+Version: 2.1.0.dev1
 Summary: Command-line interface for ViUR application maintenance.
 Home-page: https://github.com/viur-framework/viur-cli
 Author: Andreas H. Kelch
@@ -194,6 +194,12 @@ It contains the default viur project profile and it can be expanded with several
                 "kind": "npm",
                 "source": ""
             }
+            /* OPTIONAL arguments, can be set in default or in a specific profile */
+            "appyaml": "app_stub.yaml",  // Use a name other than "app.yaml"
+            "appyaml_substitition": true,  // Set to true to replace only standard variables in app.yaml
+            "appyaml_substitition": {  // Set to an object to replace these in addition to the standard variables in app.yaml
+                "$REGION": "europe-west3"
+            }
         },
         "gcloud": {
             "functions": { //Declarations for a cloud function

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli.egg-info/SOURCES.txt

@@ -36,5 +36,4 @@ src/viur_cli/scriptor/scriptor/utils.py
 src/viur_cli/scriptor/scriptor/viur.py
 src/viur_cli/scriptor/scriptor/writer.py
 src/viur_cli/scripts/__init__.py
-src/viur_cli/scripts/get_pyodide.py
-src/viur_cli/scripts/viur_2to3.py
+src/viur_cli/scripts/get_pyodide.py

{viur_cli-2.0.2 → viur_cli-2.1.0.dev1}/src/viur_cli.egg-info/entry_points.txt

@@ -1,4 +1,3 @@
 [console_scripts]
 get-pyodide = viur_cli.scripts.get_pyodide:main
 viur = viur_cli:cli
-viur-2to3 = viur_cli.scripts.viur_2to3:main

viur_cli-2.0.2/src/viur_cli/scripts/viur_2to3.py

@@ -1,153 +0,0 @@
-#!/usr/bin/env python3
-"""
-Naive ViUR3 project porting script with a simple search & replace mechanism using lookup table.
-"""
-
-import os, argparse, difflib
-
-# Naive lookup table. Could be done better later...
-lookup = {
-    # old: new
-    "BasicApplication": "SkelModule",
-    "addItemSuccess": "addSuccess",
-    "callDeferred": "CallDeferred",
-    "editItemSuccess": "editSuccess",
-    "from server import": "from viur.core import",
-    "from server.bones import": "from viur.core.bones import",
-    "getEmtpyValueFunc": "getEmptyValueFunc",
-    "isLocalDevelopmentServer": "conf[\"viur.instance.is_dev_server\"]",
-    "onItemAdded": "onAdded",
-    "onItemDeleted": "onDeleted",
-    "onItemEdited": "onEdited",
-    "projectID": "conf[\"viur.instance.project_id\"]",
-    "utils.currentLanguage": "current.language",
-    "utils.currentRequestData": "current.request_data",
-    "utils.currentRequest": "current.request",
-    "utils.currentSession": "current.session",
-    "utils.getCurrentUser": "current.user.get",
-    "utils.isLocalDevelopmentServer": "conf[\"viur.instance.is_dev_server\"]",
-    "utils.projectID": "conf[\"viur.instance.project_id\"]",
-    "clearUpdateTag=True": "update_relations=False",
-    "seoLanguageMap": "seo_language_map",  # 800
-    "forcePost": "force_post",  # 800
-    "forceSSL": "force_ssl",  # 800
-    "internalExposed": "internal_exposed",  # 800
-    "Session.sameSite": "Session.same_site",
-    "Session.useSessionCookie": "Session.use_session_cookie",
-    "Session.cookieName": "Session.cookie_name",
-}
-
-bones = [
-    "base",
-    "boolean",
-    "captcha",
-    "color",
-    "credential",
-    "date",
-    "email",
-    "file",
-    "key",
-    "numeric",
-    "password",
-    "randomSlice",
-    "raw",
-    "record",
-    "relational",
-    "selectCountry",
-    "select",
-    "sortindex",
-    "spatial",
-    "string",
-    "text",
-    "treeLeaf",
-    "treeNode",
-    "user"
-]
-
-lookup.update({
-    f"{name}Bone": f"{name[0].upper()}{name[1:]}Bone" for name in bones
-})
-
-
-def make_2to3(args, filename):
-    """
-    Performs the conversion on a file with the provided options.
-    """
-    with open(filename, "r") as f:
-        original_content = content = f.read()
-
-    count = 0
-    for k, v in lookup.items():
-        if k in content:
-            content = content.replace(k, v)
-            count += 1
-
-    if count:
-        if not args.dryrun:
-            if not args.daredevil:
-                os.rename(filename, filename + ".bak")
-
-            with open(filename, "w") as f:
-                f.write(content)
-
-            print("Modified %r" % filename)
-        else:
-            print(
-                "\n".join(
-                    difflib.unified_diff(
-                        original_content.splitlines(),
-                        content.splitlines(),
-                        filename,
-                        filename
-                    )
-                )
-            )
-
-
-def main():
-    # Get arguments
-    ap = argparse.ArgumentParser(
-        description="ViUR3 porting tool"
-    )
-
-    ap.add_argument(
-        "path",
-        type=str,
-        help="Path to file or folder"
-    )
-
-    ap.add_argument(
-        "-d", "--dryrun",
-        action="store_true",
-        help="Dry-run for testing, don't modify files"
-    )
-    ap.add_argument(
-        "-x", "--daredevil",
-        action="store_true",
-        help="Don't make backups of files, just replace and deal with it"
-    )
-
-    args = ap.parse_args()
-
-    if os.path.isfile(args.path):
-        make_2to3(args, args.path)
-    else:
-        assert os.path.isdir(args.path), f"The path {args.path!r} is invalid!"
-
-        # Iterate all files in current folder
-        for root, dirs, files in os.walk(args.path):
-            # Ignore ViUR library folders
-            if any(ignore in root for ignore in ["viur", "flare", "html5"]):
-                continue
-
-            for filename in files:
-                # Ignore anything without a .py-extension
-                ext = os.path.splitext(filename)[1].lower()[1:]
-                if ext not in ["py"]:
-                    continue
-
-                make_2to3(args, os.path.join(root, filename))
-
-
-if __name__ == "__main__":
-    main()

viur_cli-2.0.2/src/viur_cli/setup.py

@@ -1,51 +0,0 @@
-import click
-import os
-from .conf import config
-from .cli import cli
-from .utils import *
-
-
-@cli.command()
-@click.argument("name")
-@click.pass_context
-def create(ctx, name):
-    """
-    Create a new ViUR project.
-
-    The 'create' command allows you to create a new ViUR project by cloning the ViUR base project and configuring it.
-    You can specify the name of the new project as the 'name' argument.
-
-    The 'create' command performs the following steps:
-
-        1. Clones the ViUR base project from the official GitHub repository.
-
-        2. Configures the new project by running 'clean-base.py'.
-
-        3. Optionally configures the project as a new gcloud project (if confirmed).
-
-    Note:
-
-        - This command initializes the new ViUR project based on the ViUR base project.
-
-        - Make sure to provide a unique project name to avoid conflicts with existing folders.
-
-    """
-    if os.path.exists(f'./{name}'):
-        echo_error(f'"{name}" Folder exists. Please use a different name or remove this folder ./{name}')
-        return
-
-    # fetch base project
-    os.system(
-        f'git clone https://github.com/viur-framework/viur-base.git {name}')
-    project_json_path = f'./{name}/project.json'
-
-    # collect project info
-    conf = config.get_profile("default")
-    appname = conf['application_name']
-
-    # run clean-base
-    os.system(f'cd ./{name} && python3 clean-base.py -A={appname}')
-
-    # run gcloud config
-    if click.confirm(f'Do you want to configure "{appname}" as a new gcloud project?'):
-        os.system(f'cd ./{name} && ./viur-gcloud-setup.sh {appname}')