splent-cli 0.0.1__tar.gz

splent_cli-0.0.1/LICENSE

@@ -0,0 +1,113 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of protecting
+users' freedom to change the software. The systematic pattern of such
+abuse occurs in the area of products for individuals to use, which is
+precisely where it is most unacceptable. Therefore, we have designed
+this version of the GPL to prohibit the practice for those products. If
+such problems arise substantially in other domains, we stand ready to
+extend this provision to those domains in future versions of the GPL, as
+needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                        TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+(El texto completo es largo, puedes encontrarlo en https://www.gnu.org/licenses/gpl-3.0.txt)
+

splent_cli-0.0.1/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.2
+Name: splent_cli
+Version: 0.0.1
+Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
+Author-email: David Romero <drorganvidez@us.es>
+License:                     GNU GENERAL PUBLIC LICENSE
+                               Version 3, 29 June 2007
+        
+         Copyright (C) 2007 Free Software Foundation, Inc.
+         Everyone is permitted to copy and distribute verbatim copies
+         of this license document, but changing it is not allowed.
+        
+                                    Preamble
+        
+          The GNU General Public License is a free, copyleft license for
+        software and other kinds of works.
+        
+          The licenses for most software and other practical works are designed
+        to take away your freedom to share and change the works. By contrast,
+        the GNU General Public License is intended to guarantee your freedom to
+        share and change all versions of a program--to make sure it remains free
+        software for all its users. We, the Free Software Foundation, use the
+        GNU General Public License for most of our software; it applies also to
+        any other work released this way by its authors. You can apply it to
+        your programs, too.
+        
+          When we speak of free software, we are referring to freedom, not
+        price. Our General Public Licenses are designed to make sure that you
+        have the freedom to distribute copies of free software (and charge for
+        them if you wish), that you receive source code or can get it if you
+        want it, that you can change the software or use pieces of it in new
+        free programs, and that you know you can do these things.
+        
+          To protect your rights, we need to prevent others from denying you
+        these rights or asking you to surrender the rights. Therefore, you have
+        certain responsibilities if you distribute copies of the software, or if
+        you modify it: responsibilities to respect the freedom of others.
+        
+          For example, if you distribute copies of such a program, whether
+        gratis or for a fee, you must pass on to the recipients the same
+        freedoms that you received. You must make sure that they, too, receive
+        or can get the source code. And you must show them these terms so they
+        know their rights.
+        
+          Developers that use the GNU GPL protect your rights with two steps:
+        (1) assert copyright on the software, and (2) offer you this License
+        giving you legal permission to copy, distribute and/or modify it.
+        
+          For the developers' and authors' protection, the GPL clearly explains
+        that there is no warranty for this free software. For both users' and
+        authors' sake, the GPL requires that modified versions be marked as
+        changed, so that their problems will not be attributed erroneously to
+        authors of previous versions.
+        
+          Some devices are designed to deny users access to install or run
+        modified versions of the software inside them, although the manufacturer
+        can do so. This is fundamentally incompatible with the aim of protecting
+        users' freedom to change the software. The systematic pattern of such
+        abuse occurs in the area of products for individuals to use, which is
+        precisely where it is most unacceptable. Therefore, we have designed
+        this version of the GPL to prohibit the practice for those products. If
+        such problems arise substantially in other domains, we stand ready to
+        extend this provision to those domains in future versions of the GPL, as
+        needed to protect the freedom of users.
+        
+          Finally, every program is threatened constantly by software patents.
+        States should not allow patents to restrict development and use of
+        software on general-purpose computers, but in those that do, we wish to
+        avoid the special danger that patents applied to a free program could
+        make it effectively proprietary. To prevent this, the GPL assures that
+        patents cannot be used to render the program non-free.
+        
+          The precise terms and conditions for copying, distribution and
+        modification follow.
+        
+                                TERMS AND CONDITIONS
+        
+          0. Definitions.
+        
+          "This License" refers to version 3 of the GNU General Public License.
+        
+          "Copyright" also means copyright-like laws that apply to other kinds
+        of works, such as semiconductor masks.
+        
+          "The Program" refers to any copyrightable work licensed under this
+        License. Each licensee is addressed as "you". "Licensees" and
+        "recipients" may be individuals or organizations.
+        
+          To "modify" a work means to copy from or adapt all or part of the work
+        in a fashion requiring copyright permission, other than the making of an
+        exact copy. The resulting work is called a "modified version" of the
+        earlier work or a work "based on" the earlier work.
+        
+          A "covered work" means either the unmodified Program or a work based
+        on the Program.
+        
+          To "propagate" a work means to do anything with it that, without
+        permission, would make you directly or secondarily liable for
+        infringement under applicable copyright law, except executing it on a
+        computer or modifying a private copy. Propagation includes copying,
+        distribution (with or without modification), making available to the
+        public, and in some countries other activities as well.
+        
+          To "convey" a work means any kind of propagation that enables other
+        parties to make or receive copies. Mere interaction with a user through
+        a computer network, with no transfer of a copy, is not conveying.
+        
+          An interactive user interface displays "Appropriate Legal Notices"
+        to the extent that it includes a convenient and prominently visible
+        feature that (1) displays an appropriate copyright notice, and (2)
+        tells the user that there is no warranty for the work (except to the
+        extent that warranties are provided), that licensees may convey the
+        work under this License, and how to view a copy of this License. If
+        the interface presents a list of user commands or options, such as a
+        menu, a prominent item in the list meets this criterion.
+        
+        (El texto completo es largo, puedes encontrarlo en https://www.gnu.org/licenses/gpl-3.0.txt)
+        
+        
+Project-URL: Homepage, https://github.com/diverso-lab/splent_cli
+Project-URL: Issues, https://github.com/diverso-lab/splent_cli/issues
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: python-dotenv
+Requires-Dist: flask
+Requires-Dist: setuptools
+Requires-Dist: pytest
+Requires-Dist: pytest-cov
+Requires-Dist: ruff
+
+# splent_cli

splent_cli-0.0.1/README.md

@@ -0,0 +1 @@
+# splent_cli

splent_cli-0.0.1/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splent_cli"
+version = "0.0.1"
+description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [{ name = "David Romero", email = "drorganvidez@us.es" }]
+license = { file = "LICENSE" }
+dependencies = [
+    "click",
+    "python-dotenv",
+    "flask",
+    "setuptools",
+    "pytest",
+    "pytest-cov",
+    "ruff"
+]
+
+[tool.black]
+line-length = 79
+
+[project.scripts]
+splent_cli = "splent_cli.__main__:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["splent_cli*"] 
+
+[project.urls]
+Homepage = "https://github.com/diverso-lab/splent_cli"
+Issues = "https://github.com/diverso-lab/splent_cli/issues"

splent_cli-0.0.1/setup.cfg

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

splent_cli-0.0.1/splent_cli/__init__.py

@@ -0,0 +1,6 @@
+import os
+import sys
+
+# Add the project's root directory to the PYTHONPATH
+# This allows Python to locate modules in the parent directory, enabling relative imports.
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))

splent_cli-0.0.1/splent_cli/__main__.py

@@ -0,0 +1,11 @@
+from splent_cli.cli import check_working_dir, cli, load_commands
+
+
+def main():
+    check_working_dir()
+    load_commands(cli)
+    cli()
+
+
+if __name__ == "__main__":
+    main()

splent_cli-0.0.1/splent_cli/cli.py

@@ -0,0 +1,59 @@
+import os
+import sys
+import importlib
+import click
+from dotenv import load_dotenv
+from flask.cli import FlaskGroup  # 📌 Añadir FlaskGroup
+from splent_app import create_app  # 📌 Importar la app de Flask
+
+from splent_cli.utils.path_utils import PathUtils
+
+load_dotenv()
+
+
+def check_working_dir():
+    working_dir = os.getenv("WORKING_DIR", "").strip()
+
+    if not working_dir:
+        return
+
+    if working_dir in ["/app", "/vagrant", "/app/", "/vagrant/"] and not os.path.exists(working_dir):
+        print(f"⚠️  WARNING: WORKING_DIR is set to '{working_dir}', but the directory does not exist.")
+        sys.exit(1)
+
+
+class SPLENTCLI(FlaskGroup):  # 📌 Usamos FlaskGroup para conectar con Flask
+    def __init__(self, **kwargs):
+        super().__init__(create_app=create_app, **kwargs)
+
+    def get_command(self, ctx, cmd_name):
+        rv = super().get_command(ctx, cmd_name)
+        if rv is None:
+            click.echo(f"No such command '{cmd_name}'.")
+            click.echo("Try 'splent_cli --help' for a list of available commands.")
+        return rv
+
+
+def load_commands(cli_group, commands_dir="splent_cli/commands"):
+    """
+    Dynamically import all commands in the specified directory and add them to the CLI group.
+    """
+    commands_path = PathUtils.get_commands_path()
+
+    for file in os.listdir(commands_path):
+        if file.endswith(".py") and not file.startswith("__"):
+            module_name = f"splent_cli.commands.{file[:-3]}"
+            module = importlib.import_module(module_name)
+            for attr_name in dir(module):
+                attr = getattr(module, attr_name)
+                if isinstance(attr, click.Command):
+                    cli_group.add_command(attr)
+
+
+@click.group(cls=SPLENTCLI)
+def cli():
+    """A CLI tool to help with project development."""
+
+
+if __name__ == "__main__":
+    cli()

splent_cli-0.0.1/splent_cli/commands/clear_cache.py

@@ -0,0 +1,90 @@
+from pathlib import Path
+
+import click
+import shutil
+import os
+
+from splent_cli.utils.path_utils import PathUtils
+
+
+@click.command(
+    "clear:cache",
+    help="Clears pytest cache in app/modules and the build directory at the root.",
+)
+def clear_cache():
+
+    if click.confirm(
+        "Are you sure you want to clear the pytest cache and the build directory?"
+    ):
+
+        project_root = Path(os.getenv("WORKING_DIR", ""))
+
+        pytest_cache_dir = os.path.join(
+            PathUtils.get_modules_dir(), ".pytest_cache"
+        )
+
+        build_dir = os.path.join(os.getenv("WORKING_DIR", ""), "build")
+
+        if os.path.exists(pytest_cache_dir):
+            try:
+                shutil.rmtree(pytest_cache_dir)
+                click.echo(click.style("Pytest cache cleared.", fg="green"))
+            except Exception as e:
+                click.echo(
+                    click.style(f"Failed to clear pytest cache: {e}", fg="red")
+                )
+        else:
+            click.echo(
+                click.style(
+                    "No pytest cache found. Nothing to clear.", fg="yellow"
+                )
+            )
+
+        if os.path.exists(build_dir):
+            try:
+                shutil.rmtree(build_dir)
+                click.echo(click.style("Build directory cleared.", fg="green"))
+            except Exception as e:
+                click.echo(
+                    click.style(
+                        f"Failed to clear build directory: {e}", fg="red"
+                    )
+                )
+        else:
+            click.echo(
+                click.style(
+                    "No cache or build directory found. Nothing to clear.",
+                    fg="yellow",
+                )
+            )
+
+        pycache_dirs = project_root.rglob("__pycache__")
+        for dir in pycache_dirs:
+            try:
+                shutil.rmtree(dir)
+            except Exception as e:
+                click.echo(
+                    click.style(
+                        f"Failed to clear __pycache__ directory {dir}: {e}",
+                        fg="red",
+                    )
+                )
+        click.echo(
+            click.style("All __pycache__ directories cleared.", fg="green")
+        )
+
+        pyc_files = project_root.rglob("*.pyc")
+        for file in pyc_files:
+            try:
+                file.unlink()
+            except Exception as e:
+                click.echo(
+                    click.style(
+                        f"Failed to clear .pyc file {file}: {e}", fg="red"
+                    )
+                )
+
+        click.echo(click.style("All cache cleared.", fg="green"))
+
+    else:
+        click.echo(click.style("Clear operation cancelled.", fg="yellow"))

splent_cli-0.0.1/splent_cli/commands/clear_log.py

@@ -0,0 +1,31 @@
+import click
+import os
+
+from splent_cli.utils.path_utils import PathUtils
+
+
+@click.command("clear:log", help="Clears the 'app.log' file.")
+def clear_log():
+    log_file_path = PathUtils.get_app_log_dir()
+
+    # Check if the log file exists
+    if os.path.exists(log_file_path):
+        try:
+            # Deletes the log file
+            os.remove(log_file_path)
+            click.echo(
+                click.style(
+                    "The 'app.log' file has been successfully cleared.",
+                    fg="green",
+                )
+            )
+        except Exception as e:
+            click.echo(
+                click.style(
+                    f"Error clearing the 'app.log' file: {e}", fg="red"
+                )
+            )
+    else:
+        click.echo(
+            click.style("The 'app.log' file does not exist.", fg="yellow")
+        )

splent_cli-0.0.1/splent_cli/commands/clear_uploads.py

@@ -0,0 +1,44 @@
+import click
+import shutil
+import os
+
+from splent_cli.utils.path_utils import PathUtils
+
+
+@click.command(
+    "clear:uploads",
+    help="Clears the contents of the 'uploads' directory without removing the folder.",
+)
+def clear_uploads():
+    uploads_dir = PathUtils.get_uploads_dir()
+
+    # Verify if the 'uploads' folder exists
+    if os.path.exists(uploads_dir) and os.path.isdir(uploads_dir):
+        try:
+            # Iterate over the contents of the directory
+            for filename in os.listdir(uploads_dir):
+                file_path = os.path.join(uploads_dir, filename)
+
+                # If it's a file, remove it
+                if os.path.isfile(file_path) or os.path.islink(file_path):
+                    os.remove(file_path)
+                # If it's a directory, remove it and its contents
+                elif os.path.isdir(file_path):
+                    shutil.rmtree(file_path)
+
+            click.echo(
+                click.style(
+                    "The contents of the 'uploads' directory have been successfully cleared.",
+                    fg="green",
+                )
+            )
+        except Exception as e:
+            click.echo(
+                click.style(
+                    f"Error clearing the 'uploads' directory: {e}", fg="red"
+                )
+            )
+    else:
+        click.echo(
+            click.style("The 'uploads' directory does not exist.", fg="yellow")
+        )

splent_cli-0.0.1/splent_cli/commands/compose_env.py

@@ -0,0 +1,50 @@
+import os
+import click
+from dotenv import dotenv_values
+from flask.cli import with_appcontext
+
+from splent_cli.utils.path_utils import PathUtils
+
+
+@click.command(
+    "compose:env",
+    help="Combines .env files from blueprints with the root .env, checking for conflicts.",
+)
+@with_appcontext
+def compose_env():
+
+    modules_dir = PathUtils.get_modules_dir()
+    root_env_path = PathUtils.get_env_dir()
+
+    # Loads the current root .env variables into a dictionary
+    root_env_vars = dotenv_values(root_env_path)
+
+    # Finds and processes all blueprints .env files
+    module_env_paths = [
+        os.path.join(root, ".env")
+        for root, dirs, files in os.walk(modules_dir)
+        if ".env" in files
+    ]
+    for env_path in module_env_paths:
+        blueprint_env_vars = dotenv_values(env_path)
+        # Add or update the blueprint variables in the root .env dictionary
+        for key, value in blueprint_env_vars.items():
+            if key in root_env_vars and root_env_vars[key] != value:
+                conflict_msg = (
+                    f"Conflict found for variable '{key}' in {env_path}. "
+                    "Keeping the original value."
+                )
+                click.echo(click.style(conflict_msg, fg="yellow"))
+                continue
+            root_env_vars[key] = value
+
+    # Write back to the root .env file
+    with open(root_env_path, "w") as root_env_file:
+        for key, value in root_env_vars.items():
+            root_env_file.write(f"{key}={value}\n")
+
+    click.echo(
+        click.style(
+            "Successfully merged .env files without conflicts.", fg="green"
+        )
+    )

splent_cli-0.0.1/splent_cli/commands/coverage.py

@@ -0,0 +1,46 @@
+import click
+import subprocess
+import os
+
+from splent_cli.utils.path_utils import PathUtils
+
+
+@click.command(
+    "coverage",
+    help="Runs pytest coverage on the blueprints directory or a specific module.",
+)
+@click.argument("module_name", required=False)
+@click.option(
+    "--html", is_flag=True, help="Generates an HTML coverage report."
+)
+def coverage(module_name, html):
+    modules_dir = PathUtils.get_modules_dir()
+    test_path = modules_dir
+
+    if module_name:
+        test_path = os.path.join(modules_dir, module_name)
+        if not os.path.exists(test_path):
+            click.echo(
+                click.style(
+                    f"Module '{module_name}' does not exist.", fg="red"
+                )
+            )
+            return
+        click.echo(f"Running coverage for the '{module_name}' module...")
+    else:
+        click.echo("Running coverage for all modules...")
+
+    coverage_cmd = [
+        "pytest",
+        "--ignore-glob=*selenium*",
+        "--cov=" + test_path,
+        test_path,
+    ]
+
+    if html:
+        coverage_cmd.extend(["--cov-report", "html"])
+
+    try:
+        subprocess.run(coverage_cmd, check=True)
+    except subprocess.CalledProcessError as e:
+        click.echo(click.style(f"Error running coverage: {e}", fg="red"))

splent_cli-0.0.1/splent_cli/commands/db_console.py

@@ -0,0 +1,27 @@
+import click
+import subprocess
+from dotenv import load_dotenv
+import os
+
+
+@click.command(
+    "db:console", help="Opens a MariaDB console with credentials from .env."
+)
+def db_console():
+    load_dotenv()
+
+    mariadb_hostname = os.getenv("MARIADB_HOSTNAME")
+    mariadb_user = os.getenv("MARIADB_USER")
+    mariadb_password = os.getenv("MARIADB_PASSWORD")
+    mariadb_database = os.getenv("MARIADB_DATABASE")
+
+    # Build the command to connect to MariaDB
+    mariadb_connect_cmd = f"mysql -h{mariadb_hostname} -u{mariadb_user} -p{mariadb_password} {mariadb_database}"
+
+    # Execute the command
+    try:
+        subprocess.run(mariadb_connect_cmd, shell=True, check=True)
+    except subprocess.CalledProcessError as e:
+        click.echo(
+            click.style(f"Error opening MariaDB console: {e}", fg="red")
+        )