Skip to content

Latest commit

 

History

History
204 lines (125 loc) · 6.9 KB

README.rst

File metadata and controls

204 lines (125 loc) · 6.9 KB
Raw

Picasso Tutor Plugin

Maintainance Status GitHub Actions Workflow Test Status GitHub Actions Workflow Integration Test Status

Picasso is a Tutor plugin that streamlines and automates complex pre-build tasks into a cohesive command.

Current features include:

  • Adding private requirements: install private packages or dependencies in edx-platform.
  • Executing a bundle of commands: run multiple commands in a specific order with a single command.
  • Adding themes: manage custom themes to personalize Open edX.

This plugin is based on https://github.com/eduNEXT/tutor-contrib-edunext-distro

Index

Installation

pip install git+https://github.com/eduNEXT/tutor-contrib-picasso

Enable the plugin

# To enable the plugin
tutor plugins enable picasso

# Show the picasso commands
tutor picasso -h

Usage

Remember to follow the procedure you need before building your images.

Enable Private Packages

To enable the installation of private Open edX Django apps, follow these steps:

  1. Add configuration to the configuration file

First, add the necessary configuration in your Tutor environment's config.yml file:

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.

  1. Save the configuration with tutor config save
  2. Run the following command to enable private packages:
# Enable private packages
tutor picasso 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.

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.

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

To enable themes in your Tutor environment, follow these steps:

  1. Add the necessary configuration in your Tutor environment's config.yml file:
TUTOR_VERSION: <the version of the tutor your installation used. e.g., v18.1.1>
PICASSO_THEMES:
- name: <your_theme_repository>
  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_repository>
  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>
PICASSO_THEMES_NAME:
- <your theme name. e.g., bragi>
- <another theme name. e.g., pearson-theme>
PICASSO_THEME_DIRS:
- <the directory where you store your themes. e.g., /openedx/themes/ednx-saas-themes/edx-platform>
- <another directory where you store your themes. e.g., /openedx/themes/openedx-themes/edx-platform>

Note: If your theme repository is public, you can also use the HTTPS URL in repo.

Note: The PICASSO_THEMES, PICASSO_THEME_DIRS and PICASSO_THEMES_NAME variables are lists and can have one or more elements.

  1. Save the configuration with tutor config save
  2. Run the enable command
# Enable themes
tutor picasso enable-themes

This command will clone your theme repository into the folder that Tutor uses for themes. You can find the documentation in the Installing custom theme tutorial.

If PICASSO_THEMES is defined, the plugin will set ENABLE_COMPREHENSIVE_THEMING = True.

If PICASSO_THEME_DIRS is defined, the plugin will extend the COMPREHENSIVE_THEME_DIRS by patches.

The TUTOR_VERSION, PICASSO_THEME_DIRS and PICASSO_THEMES_NAME variables are used to compile the themes. For detailed information, see the patch openedx-dockerfile-pre-assets.

You can set the PICASSO_DEFAULT_SITE_THEME (optional), which will be in DEFAULT_SITE_THEME; if not, we will use the first element in PICASSO_THEMES_NAME.

Note: Don't forget to add extra configurations in a Tutor plugin if your theme requires it.

Run Extra Commands

To execute a list of Tutor commands in your Tutor environment, follow these steps:

  1. Add the necessary configuration in your Tutor environment's config.yml file:
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>
.
.
.
  1. Save the configuration with tutor config save
  2. Run the following command
# Run Tutor commands
tutor picasso 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.

Compatibility notes

This plugin was tested from Olive release.

Note: If you want to use tutor plugin indexes, you need an Tutor version >= 15.3.0.

Note: For the Quince release, we recommend using Tutor version >= v17.0.3 as it includes an important fix related to the enable-private-package command. For more information, visit: overhangio/tutor#1016.

License

This software is licensed under the terms of the AGPLv3.