edx-sysadmin 0.1.4

Features

edx-sysadmin provides different features such as:

• Register Users:

  • You can register new user accounts with an easy to use form via Users tab.

• Delete Courses:

  • You can delete any course by using a course ID or directory via Courses tab.

• Git Import:

  • You can import any course maintained through a git repository via Git Import tab.

• Git Logs

  • You can check the logs for all imported courses through git via Git Logs tab.

Installing The Plugin

• You can install the plugin into your Open edX environment using PyPI e.g. pip install edx-sysadmin or directly from github e.g. pip install https://github.com/mitodl/edx-sysadmin.git

• Once you have installed the plugin you can visit <EDX_BASE_URL>/sysadmin to access the plugin features.

• If you decide to make your own changes in the plugin you can go to Development Workflow section below.

Note: In some cases you might need to restart edx-platform after installing the plugin to reflect the changes.

# Clone edx-sysadmin to a directory which can be accessed from inside lms container i.e. ``src`` folder of
# Open edX devstack setup, which is present under root directory (sibling directory of edx-platform directory)
# and mapped at ``/edx/src`` inside edx-platform's lms container.
cd src
git clone git@github.com:mitodl/edx-sysadmin.git

# Open LMS shell
cd ../devstack
make lms-shell

# Remove edx-sysadmin plugin if already installed
pip uninstall edx-sysadmin

# Install plugin in editable mode
pip install -e /edx/src/edx-sysadmin

# If edx-sysadmin plugin doesn't reflect anything you can simply restart lms container (optional)
make lms-restart

Testing

edx-sysadmin tests are dependednt on edx-platform that’s why they can only be run from inside of lms shell

# Enter LMS shell
cd devstack
make lms-shell

# Go to the directory where edx-sysadmin is mapped inside container i.e. ``/edx/src/edx-sysadmin``
cd /edx/src/edx-sysadmin

# Install requirements for running tests (you can also install requirements inside a virtual environment)
pip install -r ./requirements/quality.txt

# Run Pytest
pytest .

# Run black formatter
black --check .

# Run Pycodestyle
pycodestyle edx_sysadmin tests

# Run Pylint
pylint ./edx_sysadmin