viur-cli 2.2.0__tar.gz → 2.3.0__tar.gz

{viur_cli-2.2.0 → viur_cli-2.3.0}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.4
-Name: viur_cli
-Version: 2.2.0
+Name: viur-cli
+Version: 2.3.0
 Summary: Command-line interface for ViUR application maintenance.
-Home-page: https://github.com/viur-framework/viur-cli
-Author: Andreas H. Kelch
-Author-email: ak@mausbrand.de
+Author-email: "Andreas H. Kelch" <ak@mausbrand.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/viur-framework/viur-cli
 Project-URL: Bug Tracker, https://github.com/viur-framework/viur-cli/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: app_server~=1.0
+Requires-Dist: app-server~=1.0
 Requires-Dist: click~=8.1.7
 Requires-Dist: pipfile-requirements~=0.3
 Requires-Dist: requests~=2.0
 Requires-Dist: semver~=3.0
 Requires-Dist: watchdog~=6.0
+Requires-Dist: safety~=3.5
+Requires-Dist: viur-scriptor-api~=1.0
 Dynamic: license-file
 
 <div align="center">
@@ -46,6 +47,52 @@ To use `viur-cli` in your ViUR projects, install the [PyPI package `viur-cli`](h
 $ pipenv install --dev viur-cli
 ```
 
+## Shell Autocompletion
+
+`viur-cli` supports shell autocompletion for bash, zsh, and fish shells. This makes it easier to use the CLI by providing tab-completion for commands and options.
+
+### Installing Autocompletion
+
+To install autocompletion for your shell, run:
+
+```bash
+$ viur setup-autocomplete
+```
+
+This will automatically detect your shell and set up the appropriate completion script. You can also specify a shell explicitly:
+
+```bash
+$ viur setup-autocomplete --shell=bash  # For bash
+$ viur setup-autocomplete --shell=zsh   # For zsh
+$ viur setup-autocomplete --shell=fish  # For fish
+```
+
+After installation, restart your shell or source your shell configuration file:
+
+```bash
+# For bash
+$ source ~/.bashrc
+
+# For zsh
+$ source ~/.zshrc
+```
+
+### Checking Autocompletion Status
+
+To see if autocompletion is installed and get more information:
+
+```bash
+$ viur autocomplete-info
+```
+
+### Uninstalling Autocompletion
+
+To remove the autocompletion setup:
+
+```bash
+$ viur uninstall-autocomplete
+```
+
 ## Usage
 
 ```sh

viur_cli-2.2.0/src/viur_cli.egg-info/PKG-INFO → viur_cli-2.3.0/README.md

@@ -1,25 +1,3 @@
-Metadata-Version: 2.4
-Name: viur_cli
-Version: 2.2.0
-Summary: Command-line interface for ViUR application maintenance.
-Home-page: https://github.com/viur-framework/viur-cli
-Author: Andreas H. Kelch
-Author-email: ak@mausbrand.de
-Project-URL: Bug Tracker, https://github.com/viur-framework/viur-cli/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: app_server~=1.0
-Requires-Dist: click~=8.1.7
-Requires-Dist: pipfile-requirements~=0.3
-Requires-Dist: requests~=2.0
-Requires-Dist: semver~=3.0
-Requires-Dist: watchdog~=6.0
-Dynamic: license-file
-
 <div align="center">
     <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-cli.svg" height="196" alt="A hexagonal logo of the viur-cli" title="viur-cli">
     <h1>viur-cli</h1>
@@ -46,6 +24,52 @@ To use `viur-cli` in your ViUR projects, install the [PyPI package `viur-cli`](h
 $ pipenv install --dev viur-cli
 ```
 
+## Shell Autocompletion
+
+`viur-cli` supports shell autocompletion for bash, zsh, and fish shells. This makes it easier to use the CLI by providing tab-completion for commands and options.
+
+### Installing Autocompletion
+
+To install autocompletion for your shell, run:
+
+```bash
+$ viur setup-autocomplete
+```
+
+This will automatically detect your shell and set up the appropriate completion script. You can also specify a shell explicitly:
+
+```bash
+$ viur setup-autocomplete --shell=bash  # For bash
+$ viur setup-autocomplete --shell=zsh   # For zsh
+$ viur setup-autocomplete --shell=fish  # For fish
+```
+
+After installation, restart your shell or source your shell configuration file:
+
+```bash
+# For bash
+$ source ~/.bashrc
+
+# For zsh
+$ source ~/.zshrc
+```
+
+### Checking Autocompletion Status
+
+To see if autocompletion is installed and get more information:
+
+```bash
+$ viur autocomplete-info
+```
+
+### Uninstalling Autocompletion
+
+To remove the autocompletion setup:
+
+```bash
+$ viur uninstall-autocomplete
+```
+
 ## Usage
 
 ```sh

viur_cli-2.3.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = [
+    "setuptools>=65",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "viur-cli"
+dynamic = ["version"]
+authors = [
+    {name = "Andreas H. Kelch", email = "ak@mausbrand.de"}
+]
+description = "Command-line interface for ViUR application maintenance."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "app-server~=1.0",
+    "click~=8.1.7",
+    "pipfile-requirements~=0.3",
+    "requests~=2.0",
+    "semver~=3.0",
+    "watchdog~=6.0",
+    "safety~=3.5",
+    "viur-scriptor-api~=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/viur-framework/viur-cli"
+"Bug Tracker" = "https://github.com/viur-framework/viur-cli/issues"
+
+[project.scripts]
+viur = "viur_cli:cli"
+get-pyodide = "viur_cli.scripts.get_pyodide:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = {find = {where = ["src"]}}
+
+[tool.setuptools.dynamic]
+version = {attr = "viur_cli.version.__version__"}

viur_cli-2.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

viur_cli-2.3.0/src/viur_cli/cli.py

@@ -0,0 +1,260 @@
+import re
+import subprocess
+import click
+from .conf import *
+from .version import __version__
+from .version import MINIMAL_PIPENV
+import semver
+import pprint
+import os
+from pathlib import Path
+
+
+@click.group(invoke_without_command=True, no_args_is_help=True,
+             context_settings={"help_option_names": ["-h", "--help"]})
+@click.version_option(__version__)
+@click.pass_context
+def cli(ctx):
+    """
+    Command-line interface for managing project configuration and information.
+
+    The viur-cli provides a set of commands to manage your project's configuration in the 'project.json'.
+     It also offers commands to view and modify project information.
+
+    Note:
+
+        - Use the `--version` option to display the CLI tool's version.
+
+        - Run the 'project' command to manage 'project.json' and project configuration settings.
+    """
+
+    # Get the systems pipenv Version Number
+    pipenv_version = subprocess.check_output(['pipenv', '--version']).decode("utf-8")
+    version_pattern = r'\b(\d+\.\d+\.\d+)\b'
+    match = re.search(version_pattern, pipenv_version)
+    sys_pipenv = match.group(1)
+
+    # sys kleiner min
+    if semver.compare(sys_pipenv, MINIMAL_PIPENV) < 0:
+        echo_warning(
+            f"Your pipenv Version does not match the recommended pipenv version. \n"
+            f"This mismatch may cause Errors, please consider updating your Systems pipenv version \n"
+            f"Your Version: {sys_pipenv}\n"
+            f"Recommended Version: {MINIMAL_PIPENV}"
+        )
+
+
+@cli.command()
+@click.argument("action", type=click.Choice(['list']))
+@click.argument("profile", default="default")
+def project(action, profile):
+    """List your project.json Configuration File"""
+    project_config = config.get_profile(profile)
+    if action == "list":
+        echo_info(f"These are the Settings for {profile} profile")
+        pprint.pprint(project_config)
+
+
+@cli.command()
+@click.option('--shell', type=click.Choice(['bash', 'zsh', 'fish', 'auto']),
+              default='auto', help='Shell type (auto-detect if not specified)')
+def setup_autocomplete(shell):
+    """Install shell autocompletion for the viur CLI.
+
+    This command sets up autocompletion for your shell, making it easier
+    to use the viur CLI by providing tab-completion for commands and options.
+    """
+    # Auto-detect shell if not specified
+    if shell == 'auto':
+        shell_env = os.environ.get('SHELL', '')
+        if 'bash' in shell_env:
+            shell = 'bash'
+        elif 'zsh' in shell_env:
+            shell = 'zsh'
+        elif 'fish' in shell_env:
+            shell = 'fish'
+        else:
+            echo_error("Could not auto-detect shell. Please specify with --shell")
+            return
+
+    echo_info(f"Setting up autocompletion for {shell}...")
+
+    home = Path.home()
+
+    if shell == 'bash':
+        completion_file = home / '.viur-completion.bash'
+        rc_file = home / '.bashrc'
+
+        # Generate completion script
+        completion_script = subprocess.run(
+            ['viur'],
+            env={**os.environ, '_VIUR_COMPLETE': 'bash_source'},
+            capture_output=True,
+            text=True
+        )
+
+        if completion_script.returncode != 0:
+            echo_error("Failed to generate bash completion script")
+            return
+
+        # Write completion script
+        completion_file.write_text(completion_script.stdout)
+
+        # Add to .bashrc if not already present
+        source_line = f'source {completion_file}\n'
+        if rc_file.exists():
+            rc_content = rc_file.read_text()
+            if str(completion_file) not in rc_content:
+                with rc_file.open('a') as f:
+                    f.write(f'\n# viur CLI autocompletion\n')
+                    f.write(source_line)
+                echo_success(f"Added autocompletion to {rc_file}")
+            else:
+                echo_info("Autocompletion already configured in .bashrc")
+        else:
+            echo_warning(".bashrc not found. Please add the following line manually:")
+            echo_info(source_line)
+
+    elif shell == 'zsh':
+        completion_file = home / '.viur-completion.zsh'
+        rc_file = home / '.zshrc'
+
+        # Generate completion script
+        completion_script = subprocess.run(
+            ['viur'],
+            env={**os.environ, '_VIUR_COMPLETE': 'zsh_source'},
+            capture_output=True,
+            text=True
+        )
+
+        if completion_script.returncode != 0:
+            echo_error("Failed to generate zsh completion script")
+            return
+
+        # Write completion script
+        completion_file.write_text(completion_script.stdout)
+
+        # Add to .zshrc if not already present
+        source_line = f'source {completion_file}\n'
+        if rc_file.exists():
+            rc_content = rc_file.read_text()
+            if str(completion_file) not in rc_content:
+                with rc_file.open('a') as f:
+                    f.write(f'\n# viur CLI autocompletion\n')
+                    f.write(source_line)
+                echo_success(f"Added autocompletion to {rc_file}")
+            else:
+                echo_info("Autocompletion already configured in .zshrc")
+        else:
+            echo_warning(".zshrc not found. Please add the following line manually:")
+            echo_info(source_line)
+
+    elif shell == 'fish':
+        completion_dir = home / '.config' / 'fish' / 'completions'
+        completion_file = completion_dir / 'viur.fish'
+
+        # Create directory if it doesn't exist
+        completion_dir.mkdir(parents=True, exist_ok=True)
+
+        # Generate completion script
+        completion_script = subprocess.run(
+            ['viur'],
+            env={**os.environ, '_VIUR_COMPLETE': 'fish_source'},
+            capture_output=True,
+            text=True
+        )
+
+        if completion_script.returncode != 0:
+            echo_error("Failed to generate fish completion script")
+            return
+
+        # Write completion script
+        completion_file.write_text(completion_script.stdout)
+        echo_success(f"Installed fish completion to {completion_file}")
+
+    echo_info("\nAutocompletion setup complete!")
+    echo_info("Please restart your shell or run:")
+    if shell in ['bash', 'zsh']:
+        echo_info(f"  source {completion_file}")
+
+
+@cli.command()
+def uninstall_autocomplete():
+    """Remove shell autocompletion for the viur CLI."""
+    home = Path.home()
+    removed = False
+
+    # Remove completion files
+    completion_files = [
+        home / '.viur-completion.bash',
+        home / '.viur-completion.zsh',
+        home / '.config' / 'fish' / 'completions' / 'viur.fish'
+    ]
+
+    for file in completion_files:
+        if file.exists():
+            file.unlink()
+            echo_info(f"Removed {file}")
+            removed = True
+
+    # Clean up shell rc files
+    rc_files = [
+        (home / '.bashrc', '.viur-completion.bash'),
+        (home / '.zshrc', '.viur-completion.zsh')
+    ]
+
+    for rc_file, completion_name in rc_files:
+        if rc_file.exists():
+            content = rc_file.read_text()
+            if completion_name in content:
+                # Remove the source line and the comment before it
+                lines = content.splitlines()
+                new_lines = []
+                skip_next = False
+
+                for i, line in enumerate(lines):
+                    if '# viur CLI autocompletion' in line:
+                        skip_next = True
+                        continue
+                    if skip_next and completion_name in line:
+                        skip_next = False
+                        continue
+                    new_lines.append(line)
+
+                rc_file.write_text('\n'.join(new_lines))
+                echo_info(f"Cleaned up {rc_file}")
+                removed = True
+
+    if removed:
+        echo_success("Autocompletion uninstalled successfully")
+    else:
+        echo_info("No autocompletion files found")
+
+
+@cli.command()
+def autocomplete_info():
+    """Show autocompletion status and instructions."""
+    echo_info("viur CLI Autocompletion Information")
+    echo_info("=" * 40)
+
+    shell = os.environ.get('SHELL', 'unknown')
+    echo_info(f"Current shell: {shell}")
+
+    home = Path.home()
+    completion_files = {
+        'bash': home / '.viur-completion.bash',
+        'zsh': home / '.viur-completion.zsh',
+        'fish': home / '.config' / 'fish' / 'completions' / 'viur.fish'
+    }
+
+    installed = []
+    for shell_type, file_path in completion_files.items():
+        if file_path.exists():
+            installed.append(shell_type)
+
+    if installed:
+        echo_success(f"Autocompletion installed for: {', '.join(installed)}")
+    else:
+        echo_warning("No autocompletion installed")
+        echo_info("\nTo install, run:")
+        echo_info("  viur setup-autocomplete")

{viur_cli-2.2.0 → viur_cli-2.3.0}/src/viur_cli/cloud.py

@@ -6,7 +6,7 @@ import string
 import time
 import click
 import yaml
-from viur_cli import echo_positive, echo_warning, echo_fatal
+from viur_cli import echo_success, echo_warning, echo_fatal
 from .conf import config
 from . import cli, echo_error, echo_info, replace_vars
 from .update import create_req
@@ -305,7 +305,7 @@ def gcloud_get_roles(profile):
                 with open(json_file_path, 'w') as json_file:
                     json.dump(usable_dict, json_file, indent=4)
 
-                echo_positive(f"You can now watch your gcloud Roles Setup in your '{json_file_path}' file ")
+                echo_success(f"You can now watch your gcloud Roles Setup in your '{json_file_path}' file ")
 
         except yaml.YAMLError as e:
             echo_error(f"An error occurred during YAML to Dictionary transformation: {e}")
@@ -455,7 +455,7 @@ def deploy(action, profile, name, ext, yes, skip_checks: bool, additional_args):
                     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"]}
@@ -697,6 +697,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, "
+        echo_success("Your cloud function creation was successful, if you want to add more flags, "
                       "add them in your project.json")
-

{viur_cli-2.2.0 → viur_cli-2.3.0}/src/viur_cli/conf.py

@@ -6,18 +6,13 @@ from .utils import *
 from .version import __version__ as cli_version
 
 
-PROJECT_CONFIG_FILE = "project.json"
-PROJECT_CONFIG_VERSION = "2.0.0"
-LAST_VERSION = ""
+class Config(dict):
+    CONFIG_FILE = None
+    PROJECT_CONFIG_VERSION = None
+    LAST_VERSION = None
 
-
-class ProjectConfig(dict):
-
-    def __init__(self):
-        super().__init__()
-        self["default"] = {}
-        self["format"] = PROJECT_CONFIG_VERSION
-        self.initial_load = False
+    def __init__(self, *args, **kwargs):
+        self.load()
 
     def load(self):
         """
@@ -34,48 +29,59 @@ class ProjectConfig(dict):
             :return: dict
                 The project configuration loaded from the project.json file.
         """
-
         # Search in any parent folder for a project.json,
         # change working directory because subsequent commands
         # require for project root folder.
+
         changed = False
-        while not os.path.exists(PROJECT_CONFIG_FILE):
+        while not os.path.exists(self.CONFIG_FILE):
             os.chdir("..")
             changed = True
 
             if os.getcwd() == "/":
-                echo_fatal(f"{PROJECT_CONFIG_FILE} not found - please check if you are in the right folder.")
+                echo_fatal(f"{self.CONFIG_FILE} not found - please check if you are in the right folder.")
 
         if changed:
             echo_info(f"Project root is {os.getcwd()}")
 
         try:
-            f = open(PROJECT_CONFIG_FILE, "r")
+            f = open(self.CONFIG_FILE, "r")
             self.update(json.loads(f.read()))
 
+
         except FileNotFoundError:
-            echo_fatal(f"Can't open {PROJECT_CONFIG_FILE} for reading")
+            echo_fatal(f"Can't open {self.CONFIG_FILE} for reading")
 
         except json.decoder.JSONDecodeError as e:
             echo_fatal(
-                f"The configuration in {PROJECT_CONFIG_FILE} contains invalid JSON: {str(e)}. Please verify right syntax.")
-
+                f"The configuration in {self.CONFIG_FILE} contains invalid JSON: {str(e)}. Please verify right syntax.")
         self.migrate()
 
+    def migrate(self):
+        pass
+
     def save(self):
         """
         Write the current projectConfig dictionary to project.json.
         """
-        with open(PROJECT_CONFIG_FILE, "w") as f:
+        with open(self.CONFIG_FILE, "w") as f:
             json.dump(self, f, indent=4, sort_keys=True)
             f.write('\n')
 
+
+class ProjectConfig(Config):
+    CONFIG_FILE = "project.json"
+    PROJECT_CONFIG_VERSION = "2.0.0"
+    LAST_VERSION = ""
+
+    def __init__(self):
+
+        self["default"] = {}
+        self["format"] = self.PROJECT_CONFIG_VERSION
+        super().__init__()
+
     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:
@@ -95,7 +101,6 @@ class ProjectConfig(dict):
         else:
             for value in list(dictionary.values()):
                 if isinstance(value, dict):
-
                     self.find_key(value, target_key, target, keep=keep)
 
     def remove_key(self, dictionary, target_key):
@@ -124,7 +129,7 @@ class ProjectConfig(dict):
             self["format"] = old_format
             del self["default"]["format"]
 
-        assert self["format"] in ["1.0.0", "1.0.1", "1.1.0", "1.1.1", "1.2.0", PROJECT_CONFIG_VERSION], \
+        assert self["format"] in ["1.0.0", "1.0.1", "1.1.0", "1.1.1", "1.2.0", self.PROJECT_CONFIG_VERSION], \
             "Invalid formatversion, you have to fix it manually"
 
         # Version 1.0.1
@@ -219,4 +224,23 @@ def get_changelog_difference(response, response1):
         echo_info(line[1:])
 
 
+class ScriptorConfig(Config):
+    """
+    Manage scriptor configuration.
+    TODO miragte with other config
+    """
+    CONFIG_FILE = "viur_scriptor_config.json"
+    DEFAULT_BASE_URL = "http://localhost:8080"
+    DEFAULT_WORKING_DIR = "scripts/"
+    _instance = None
+
+    def __init__(self, *args, **kwargs):
+        self.update({
+            "base_url": self.DEFAULT_BASE_URL,
+            "working_dir": self.DEFAULT_WORKING_DIR,
+        })
+        super().__init__(*args, **kwargs)
+
+
 config = ProjectConfig()
+scriptor_config = ScriptorConfig()

{viur_cli-2.2.0 → viur_cli-2.3.0}/src/viur_cli/local.py

@@ -48,11 +48,13 @@ def run(profile, additional_args):
     conf = config.get_profile(profile)
     additional_args = list(additional_args)
 
+    if appyaml := conf.get("appyaml"):
+        additional_args.append(f"--appyaml={appyaml}")
     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)}')