Package: jupyterlab-judge
Jupyter Lab JudgeWork In Progress.A simple online judge for Jupyter Lab.HighlightsGoalNo additional system for code executionSolve and get result on Jupyter LabReplaceable backendNo Additional System For Code ExecutionTypical online judge systems require task manager for code executions.
This project uses kernels to execute codes. Therefore no other system is required.
However this architecture leads some security risks. It will be explained later.Solve And Get Result On Jupyter LabThis project includes jupyter lab extension for solving problems and submitting solutions.Replaceable Backend(WIP) Basically, problems are retrieved fromcodle.io, and submission history is stored in browsers.
Problem and submission storage can be configured.SecurityIn this system, code is executed at users' notebook server.
Therefore test cases for problems must be delivered to the users.
This could be a serious risk for some systems. Be aware of it.ArchitectureThis extension is composed of a Python package namedjupyterlab_judgefor the server extension and a NPM package namedjupyterlab-judgefor the frontend extension.Requirements0.*.*JupyterLab >= 3.01.*.*JupyterLab >= 4.0InstallTo install the extension, execute:pipinstalljupyterlab_judgeUninstallTo remove the extension, execute:pipuninstalljupyterlab_judgeTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment EnvironmentIn0.*.*, you can create Conda environment by executing :conda create -n jupyterlab-ext --override-channels --strict-channel-priority -c conda-forge -c nodefaults jupyterlab=3 cookiecutter nodejs jupyter-packaging gitIn1.*.*, you can create Conda environment by executing :conda create -n jupyterlab4-ext --override-channels --strict-channel-priority -c conda-forge -c nodefaults jupyterlab=4 nodejs=18 git copier=7 jinja2-time
conda activate jupyterlab4-extDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab_judge directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyterlab_judge# Rebuild extension Typescript source after making changesjlpmbuildYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyterlab_judge
pipuninstalljupyterlab_judgeIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-judgewithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covjupyterlab_judgeFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASETranslateAfter addingtrans.__, execute following codejupyterlab-translate update . jupyterlab_judge -l ko_KRThis will updatejupyterlab_judge.pofile with some errors. (ignore it)Add your translation tojupyterlab_judge.poand executejupyterlab-translate compile . jupyterlab_judge -l ko_KR