feat: add picasso commands in simple way

.github/workflows/commitlint.yml

@@ -0,0 +1,11 @@
+name: Lint Commit Messages
+on: [pull_request]
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v6

.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Run tests
 
 on:
   pull_request:
-    branches: [master]
+    branches: [main]
 
 jobs:
   tests:

README.rst

@@ -1,7 +1,16 @@
-picasso plugin for `Tutor <https://docs.tutor.edly.io>`__
-#########################################################
+Picasso `Tutor`_ Plugin
+#########################
 
-picasso plugin for Tutor
+|Maintainance Badge| |Test Badge|
+
+.. |Maintainance Badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
+   :alt: Maintainance Status
+.. |Test Badge| image:: https://img.shields.io/github/actions/workflow/status/edunext/tutor-contrib-picasso/.github%2Fworkflows%2Ftests.yml?label=Test
+   :alt: GitHub Actions Workflow Test Status
+
+Picasso is a `Tutor`_ plugin that simplifies pre-build processes, such as preparing Docker images with private requirements, executing commands before the build, and adding themes. Everything is managed through commands, making it easy to integrate into automated environments.
+
+This plugin is based on https://github.com/eduNEXT/tutor-contrib-edunext-distro
 
 
 Installation
@@ -16,10 +25,110 @@ Usage
 
 .. code-block:: bash
 
+    # To enable the plugin
     tutor plugins enable picasso
 
+    # Show help
+    tutor picasso -h
+
+    # Enable themes
+    tutor picasso enable-themes
+
+    # Enable private packages
+    tutor picasso enable-private-packages
+
+    # Run Tutor commands
+    tutor picasso run-extra-commands 
+
+.. note::
+
+    Remember to run these commands before build your images if they are needed.
+
+
+Compatibility notes
+*******************
+
+This plugin was tested from Palm release.
+
+About the commands
+*******************
+
+Enable Private Packages
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This command allows the installation of private Open edX Django apps. It clones the private repository and, through the ``tutor mounts`` command, adds it to the Dockerfile for inclusion in the build process. The input it takes is:
+
+.. code-block:: yaml
+    PICASSO_<YOUR_PACKAGE_NAME>_DPKG:
+    name: <your_package_name>
+    repo: <your SSH URL for cloning the repo. e.g., [email protected]:yourorg/package.git>
+    version: <your branch, tag o release for cloning. e.g., v5.2.0>
+
+.. note::
+
+    It is needed to use the SSH URL to clone private packages.
+
+.. warning::
+
+    For the mount to work correctly and include the package in the Dockerfile, it must be added to a tutor filter ``MOUNTED_DIRECTORIES``. By default, Picasso adds ``eox-*`` packages. If you need to add another private package, don't forget to include this configuration in a Tutor plugin.
+
+    .. code-block:: python
+
+        hooks.Filters.MOUNTED_DIRECTORIES.add_items(
+            [
+                ("openedx", "<your_package_name>"),
+            ]
+        )
+
+
+.. note::
+
+    If you want to use public packages, we recommend using the ``OPEN_EDX_EXTRA_PIP_REQUIREMENTS`` variable in the ``config.yml`` of your Tutor environment.
+
+
+Enable Themes
+^^^^^^^^^^^^^^
+
+This command clones your theme repository into the folder that Tutor uses for themes. Documentation available at `Installing custom theme`_ tutorial. The input it takes is:
+
+.. code-block:: yaml
+    PICASSO_THEMES:
+    - name: <your_theme_name>
+      repo: <your SSH URL for cloning the repo. e.g., [email protected]:yourorg/theme.git>
+      version: <your branch, tag o release for cloning. e.g., edunext/redwood.master>
+    - name: <another_theme_name>
+      repo: <your SSH URL for cloning the repo. e.g., [email protected]:yourorg/another_theme.git>
+      version: <your branch, tag o release for cloning. e.g., edunext/redwood.blue>
+
+.. note::
+
+    If your theme repository is public, you can also use the HTTPS URL in ``repo``.
+
+.. note::
+
+    Don't forget to add extra configurations in a Tutor plugin if your theme requires it.
+
+
+Run Extra Commands
+^^^^^^^^^^^^^^^^^^^
+
+This command allows you to run a list of Tutor commands. These commands are executed in bash and, for security reasons, are restricted to running only Tutor commands. The input it takes is:
+
+.. code-block:: yaml
+    PICASSO_EXTRA_COMMANDS:
+    - <A tutor command. e.g., tutor plugins index add X>
+    - <A tutor command. e.g., tutor plugins install mfe>
+    - <A tutor command. e.g., tutor picasso enable-themes>
+    - <A tutor command. e.g., tutor config save>
+    .
+    .
+    .
 
 License
 *******
 
 This software is licensed under the terms of the AGPLv3.
+
+
+.. _Tutor: https://docs.tutor.edly.io
+.. _Installing custom theme: https://docs.tutor.edly.io/tutorials/theming.html#theming

setup.py

@@ -41,10 +41,10 @@ def load_about():
     packages=find_packages(exclude=["tests*"]),
     include_package_data=True,
     python_requires=">=3.8",
-    install_requires=["tutor>=18.0.0,<19.0.0"],
+    install_requires=["tutor"],
     extras_require={
         "dev": [
-            "tutor[dev]>=18.0.0,<19.0.0",
+            "tutor[dev]",
         ]
     },
     entry_points={

tutorpicasso/__about__.py

@@ -1 +1 @@
-__version__ = "18.0.0"
+__version__ = "0.1.0"

tutorpicasso/commands/cli.py

@@ -0,0 +1,23 @@
+"""
+Picasso commands group.
+"""
+
+import click
+
+from tutorpicasso.commands.enable_private_packages import enable_private_packages
+from tutorpicasso.commands.enable_themes import enable_themes
+from tutorpicasso.commands.run_extra_commands import run_extra_commands
+
+
+@click.group(help="Run picasso commands")
+def picasso() -> None:
+    """
+    Main picasso command group.
+
+    This command group provides functionality to run picasso commands.
+    """
+
+
+picasso.add_command(enable_private_packages)
+picasso.add_command(run_extra_commands)
+picasso.add_command(enable_themes)

tutorpicasso/commands/enable_private_packages.py

@@ -0,0 +1,64 @@
+import os
+import subprocess
+
+# Was necessary to use this for compatibility with Python 3.8
+from typing import Any, Dict
+
+import click
+from tutor import config as tutor_config
+
+
+@click.command(name="enable-private-packages", help="Enable picasso private packages")
+def enable_private_packages() -> None:
+    """
+    Enable private packages command.
+
+    This command enables picasso private packages by cloning the packages and
+    defining them as private.
+
+    Raises:
+        Exception: If an error occurs during the cloning or defining process.
+    """
+    tutor_root = (
+        subprocess.check_output("tutor config printroot", shell=True)
+        .decode("utf-8")
+        .strip()
+    )
+    config = tutor_config.load(tutor_root)
+    packages = get_picasso_packages(config)
+    for package, info in packages.items():
+        try:
+            if not {"name", "repo", "version"}.issubset(info):
+                raise KeyError(
+                    f"{package} is missing one of the required keys: 'name', 'repo', 'version'"
+                )
+
+            if os.path.isdir(f'{tutor_root}/{info["name"]}'):
+                subprocess.call(["rm", "-rf", f'{tutor_root}/{info["name"]}'])
+
+            subprocess.call(
+                ["git", "clone", "-b", info["version"], info["repo"]], cwd=tutor_root
+            )
+            subprocess.call(["tutor", "mounts", "add", f'{tutor_root}/{info["name"]}'])
+
+        except KeyError as e:
+            raise click.ClickException(str(e))
+
+
+def get_picasso_packages(settings: Dict[str, Any]) -> Dict[str, Dict[str, Any]]:
+    """
+    Get the distribution packages from the provided settings.
+
+    Args:
+        settings (dict): The tutor configuration settings.
+
+    Returns:
+        dict: A dictionary of distribution packages, where the keys are package names
+        and the values are package details.
+    """
+    picasso_packages = {
+        key: val
+        for key, val in settings.items()
+        if key.endswith("_DPKG") and val != "None"
+    }
+    return picasso_packages

tutorpicasso/commands/enable_themes.py

@@ -0,0 +1,41 @@
+import os
+import subprocess
+from typing import Any
+
+import click
+from tutor import config as tutor_config
+
+
+@click.command(name="enable-themes", help="Enable picasso themes")
+def enable_themes() -> None:
+    """
+    Enable picasso themes.
+
+    This function enables the themes specified in the `PICASSO_THEMES` configuration
+    and applies them using the ThemeEnabler and ThemeGitRepository classes.
+    """
+    tutor_root = (
+        subprocess.check_output("tutor config printroot", shell=True)
+        .decode("utf-8")
+        .strip()
+    )
+    config: Any = tutor_config.load(tutor_root)
+
+    if config.get("PICASSO_THEMES"):
+        for theme in config["PICASSO_THEMES"]:
+            try:
+                if not {"name", "repo", "version"}.issubset(theme.keys()):
+                    raise KeyError(
+                        f"{theme} is missing one or more required keys: "
+                        "'name', 'repo', 'version'"
+                    )
+
+                theme_path = f'{tutor_root}/env/build/openedx/themes/{theme["name"]}'
+                if os.path.isdir(theme_path):
+                    subprocess.call(["rm", "-rf", theme_path])
+
+                subprocess.call(
+                    ["git", "clone", "-b", theme["version"], theme["repo"], theme_path],
+                )
+            except KeyError as e:
+                raise click.ClickException(f"Error: {str(e)}")