Apects for Sumac

Hi everyone!

I’m using OpenX with Tutor v19.0.2 and I want to try Aspects, but it doesn’t appear in the plugin list. I thought it was already enabled, but I don’t have the “Reports” tab in the course.

Is there any way to implement Aspects in this version of Tutor?

Thank you all.

Hello Gonzalo,

I was reviewing your question and I have the following comments:

Aspects is not installed by default when you deploy an Open edX instance, so it is necessary to follow some extra steps to add it.

In this case, you must install the tutor-contrib-aspects plugin. I invite you to read the Readme of this plugin, where you will find detailed steps that you must follow to perform a correct installation of this plugin: https://github.com/openedx/tutor-contrib-aspects?tab=readme-ov-file#installation

You can also find more information in the official documentation: Welcome to the Open edX Aspects documentation! — Open edX Aspects latest documentation

For the Sumac version of the platform, you can use the latest available tag at the moment, which is 2.4.0, since version 2.x of Aspects is available from the Redwood version and above.

I hope this information is useful to you.

Hi! Thanks for your reply.

I have tried a thousand times to use this command: pip install tutor-contrib-aspects

but this error always appears.

error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.

If you wish to install a non-Debian-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
sure you have python3-full installed.

If you wish to install a non-Debian packaged Python application,
it may be easiest to use pipx install xyz, which will manage a
virtual environment for you. Make sure you have pipx installed.

See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

I managed to fix that and force install it but aspects never appeared in the plugins list.
Then, force it to appear in the list, enable it, and run tutor config save

subsequently use tutor images build openedx --no-cache

Lastly, I used this: tutor images build aspects aspects-superset

but the following appeared

Error: Image ‘aspects’ could not be found

HELP !

Hi @GonzaloZupo

It sounds like you are not installing aspects into the same Python Environment in which your Tutor installation is managed. See docs here: Virtual Environment (Recommended)

When you initially installed Tutor you likely set up a Python virtual environment which you need to activate first, otherwise it’s going to default to the system-wide Python installation which is not recommended (you may be able to make it work but it’s less than ideal and may potentially cause issues)

If you want it to automatically activate upon login in future so that it’s one less step to do before you install/upgrade things, then you can append the source command to your ~/.bashrc file like this: (assuming your venv was created at /home/yourusername/env)

#Python Virtual Environment configuration
source ~/env/bin/activate

Then after logging in via SSH again you should see your env in the commandline like this:
(env) user@servername:~$
Following which any Python/PIP commands will utilise that dedicated virtual environment.

You can learn more about Virtual Environments here: venv — Creation of virtual environments — Python 3.14.0 documentation

1 Like