Metadata-Version: 2.4
Name: tutor-livedeps
Version: 20.0.0
Summary: livedeps plugin for Tutor
Project-URL: Documentation, https://github.com/overhangio/tutor-livedeps#readme
Project-URL: Issues, https://github.com/overhangio/tutor-livedeps/issues
Project-URL: Source, https://github.com/overhangio/tutor-livedeps
Author: Muhammad Labeeb
Author-email: muhammad.labeeb@arbisoft.com
License: AGPL-3.0-only
License-File: LICENSE.txt
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9
Requires-Dist: tutor-minio<21.0.0,>=20.0.0
Requires-Dist: tutor<21.0.0,>=20.0.0
Provides-Extra: dev
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: tutor[dev]<21.0.0,>=20.0.0; extra == 'dev'
Description-Content-Type: text/x-rst

Real time python package installation for Open edX
==================================================

This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ that provides real time python package installation for Open edX platforms. This means you do not need to rebuild the openedx image whenever you add a new package. This is achieved by storing these packages in Django storage and downloading them inside each LMS/CMS container.

Installation
------------

This plugin depends on the `tutor-minio <https://github.com/overhangio/tutor-minio>`_ plugin to store the packages. After installing and enabling tutor-minio run the following commands:

``tutor plugins install livedeps``

``tutor plugins enable livedeps``

Then build the openedx image:

``tutor images build openedx``

Finally, run the init task:

``tutor local/k8s do init --limit=livedeps``

This step must be performed before you start tutor otherwise your LMS/CMS containers will fail to start.


Configuration
-------------

``LIVEDEPS`` (default: ``"[]"``)

To add a new package to this config run 

``tutor config save --append LIVEDEPS=package_name``

To remove an old package from this config run 

``tutor config save --remove LIVEDEPS=package_name``

Then run the following command to install the packages that are present in the ``LIVEDEPS`` config (make sure tutor is already running before executing this command):

``tutor local/k8s do livedeps``


Troubleshooting
---------------

This Tutor plugin is maintained by Muhammad Labeeb from `Edly <https://edly.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.

License
-------

This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-minio/blob/release/LICENSE.txt>`_.