Package: edx-recommendations
A plugin for personalized recommendationsPlease tag@openedx/vanguardson any PRs or issues.  Thanks!OverviewTheedx-recommendationsis a Django app that serves REST API endpoints for
getting personalized recommendations for learner. It used different sources
like Algolia and Amplitude for recommendations.edx-recommendations is a plugin that runs under lms. It uses same configuration settings as defined in lms.
It can be used by installing in edx-platform.How to install locallyClone this repo into../src/directory (relative to your “devstack” repo location). This will mount the directoryin a way that is accessible to the lms container.From lms-shell, uninstall edx-recommendations and install your local copy. You can run the following command:pip uninstall edx-recommendations -y; pip install -e /edx/src/edx-recommendationsHow to create a new releaseCheckout to a new branch and increment__version__by the smallest possible value located inedx-recommendations/__init__.py.This will allow edx-platform to pick up the new version.Update theCHANGELOG.rstwith the brief description of your changes.Once a branch has been merged, it is necessary to create a release on github, specifying the new version from__version__set above.Testingedx-recommendations has an assortment of test cases and code quality
checks to catch potential problems during development.  To run them all in the
version of Python you chose for your virtualenv:$makevalidateTo run just the unit tests:$maketestTo run just the unit tests and check diff coverage$makediff_coverTo run just the code quality checks:$makequalityTo run the unit tests under every supported Python version and the code
quality checks:$maketest-allTo generate and open an HTML report of how much of the code is covered by
test cases:$makecoverageLicenseThe code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.Please seeLICENSE.txtfor details.How To ContributeContributions are very welcome.Please readHow To Contributefor details.The pull request description template should be automatically applied if you are creating a pull request from GitHub. Otherwise you
can find it atPULL_REQUEST_TEMPLATE.md.The issue report template should be automatically applied if you are creating an issue on GitHub as well. Otherwise you
can find it atISSUE_TEMPLATE.md.Reporting Security IssuesPlease do not report security issues in public. Please emailsecurity@edx.org.Getting HelpHave a question about this repository, or about Open edX in general?  Please
refer to thislist of resourcesif you need any assistance.Change LogUnreleased[1.0.6] - 2023-09-25What’s Changed* Updated settings file and default values[1.0.5] - 2023-09-25What’s Changed* Fixed formatting for PyPI release[1.0.4] - 2023-09-25What’s Changed* Added PyPI publish workflow for the package[1.0.3] - 2023-09-22What’s Changed* Added Support for Django 4.2[1.0.2] - 2023-08-25What’s ChangedAdded recommendations unavailable event for learner home amplitude recommendationsRemoved constraint for edx-drf-extensionsDocumentation UpdatesUpdated docstring for cross product recommendations api endpoint[1.0.0] - 2023-08-09What’s ChangedMoved existing recommendations APIs to this pluginAdded tests for the APIs and utilsDocumentation UpdatesAdded purpose of this repo as an ADRAdded pull request template and updated README file with initial setup guide[0.1.0] – 2023-05-15First release on PyPI.