openedx-course-enrollment-audit 1.0.1

One-Time Setup

# Clone the repository
git clone git@github.com:open-craft/openedx-course-enrollment-audit.git
cd openedx-course-enrollment-audit

# Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
mkvirtualenv -p python3.11 openedx-course-enrollment-audit

Tutor Installation

To install this plugin using Tutor:

# Mount the directory in Tutor
tutor mounts add openedx:/local/projects/shared-src:/openedx/shared-src

# Install the package
tutor dev exec lms pip install -e /openedx/shared-src/openedx-course-enrollment-audit

# Run migrations
tutor dev exec lms ./manage.py lms migrate openedx_course_enrollment_audit

Every time you develop something in this repo

# Activate the virtualenv
workon openedx-course-enrollment-audit

# 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 static analysis and packaging tests
make test

# Run integration tests within Tutor
tutor dev exec lms -- bash -c "cd /openedx/shared-src/openedx-course-enrollment-audit && make test_integration"

# Commit all your changes
git commit ...
git push

# Open a PR and ask for review.

Native Installation

To deploy this to an Open edX instance, include it in the EDXAPP_PRIVATE_REQUIREMENTS or EDXAPP_EXTRA_REQUIREMENTS variables.

Tutor Installation

To install this in the Open edX build, include it in the config.yml file using the OPENEDX_EXTRA_PIP_REQUIREMENTS variable.

You need to rebuild the Open edX image:

tutor images build openedx