Plugin for a learning assistant backend, intended for use within edx-platform.
This library contains data models and logic for a platform wide learning assistant.
In addition to the edx-platform repository in which this library is installed, this plugin also leverages the frontend-lib-learning-assistant as a frontend interface for the learning assistant.
# Clone the repository git clone [email protected]:openedx/learning-assistant.git cd learning-assistant # Set up a virtualenv with the same name as the repo and activate it # Here's how you might do that if you have virtualenvwrapper setup. mkvirtualenv -p python3.8 learning-assistant
# Activate the virtualenv # Here's how you might do that if you're using virtualenvwrapper. workon learning-assistant # Grab the latest code git checkout main git pull # Install/update the dev requirements make requirements # Run the tests and quality checks (to verify the status before you make any changes) make validate # Make a new branch for your changes git checkout -b <your_github_username>/<short_description> # Using your favorite editor, edit the code to make your change. vim ... # Run your new tests pytest ./path/to/new/tests # Run all the tests and quality checks make validate # Commit all your changes git commit ... git push # Open a PR and ask for review.
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
This repo is not currently accepting contributions.
All community members are expected to follow the Open edX Code of Conduct.
Please do not report security issues in public. Please email [email protected].