Merge pull request #4 from helxplatform/rename

Rename extension

.github/workflows/build.yml

@@ -36,12 +36,12 @@ jobs:
         set -eux
         python -m pip install .[test]
 
-        pytest -vv -r ap --cov jupyterlab_eduhelx_submission
+        pytest -vv -r ap --cov eduhelx_jupyterlab_student
         jupyter server extension list
-        jupyter server extension list 2>&1 | grep -ie "jupyterlab_eduhelx_submission.*OK"
+        jupyter server extension list 2>&1 | grep -ie "eduhelx_jupyterlab_student.*OK"
 
         jupyter labextension list
-        jupyter labextension list 2>&1 | grep -ie "jupyterlab_eduhelx_submission.*OK"
+        jupyter labextension list 2>&1 | grep -ie "eduhelx_jupyterlab_student.*OK"
         python -m jupyterlab.browser_check
 
     - name: Package the extension
@@ -50,13 +50,13 @@ jobs:
 
         pip install build
         python -m build
-        pip uninstall -y "jupyterlab_eduhelx_submission" jupyterlab
+        pip uninstall -y "eduhelx_jupyterlab_student" jupyterlab
 
     - name: Upload extension packages
       uses: actions/upload-artifact@v3
       with:
         name: extension-artifacts
-        path: dist/jupyterlab_eduhelx_submission*
+        path: dist/eduhelx_jupyterlab_student*
         if-no-files-found: error
 
   test_isolated:
@@ -81,14 +81,14 @@ jobs:
         sudo rm -rf $(which node)
         sudo rm -rf $(which node)
 
-        pip install "jupyterlab>=4.0.0,<5" jupyterlab_eduhelx_submission*.whl
+        pip install "jupyterlab>=4.0.0,<5" eduhelx_jupyterlab_student*.whl
 
 
         jupyter server extension list
-        jupyter server extension list 2>&1 | grep -ie "jupyterlab_eduhelx_submission.*OK"
+        jupyter server extension list 2>&1 | grep -ie "eduhelx_jupyterlab_student.*OK"
 
         jupyter labextension list
-        jupyter labextension list 2>&1 | grep -ie "jupyterlab_eduhelx_submission.*OK"
+        jupyter labextension list 2>&1 | grep -ie "eduhelx_jupyterlab_student.*OK"
         python -m jupyterlab.browser_check --no-browser-test
 
   integration-tests:
@@ -114,7 +114,7 @@ jobs:
     - name: Install the extension
       run: |
         set -eux
-        python -m pip install "jupyterlab>=4.0.0,<5" jupyterlab_eduhelx_submission*.whl
+        python -m pip install "jupyterlab>=4.0.0,<5" eduhelx_jupyterlab_student*.whl
 
     - name: Install dependencies
       working-directory: ui-tests
@@ -142,7 +142,7 @@ jobs:
       if: always()
       uses: actions/upload-artifact@v3
       with:
-        name: jupyterlab_eduhelx_submission-playwright-tests
+        name: eduhelx-jupyterlab-student-playwright-tests
         path: |
           ui-tests/test-results
           ui-tests/playwright-report

.github/workflows/check-release.yml

@@ -25,5 +25,5 @@ jobs:
       - name: Upload Distributions
         uses: actions/upload-artifact@v3
         with:
-          name: jupyterlab_eduhelx_submission-releaser-dist-${{ github.run_number }}
+          name: eduhelx-jupyterlab-student-releaser-dist-${{ github.run_number }}
           path: .jupyter_releaser_checkout/dist

.gitignore

@@ -7,9 +7,9 @@ node_modules/
 *.egg-info/
 .ipynb_checkpoints
 *.tsbuildinfo
-jupyterlab_eduhelx_submission/labextension
+eduhelx_jupyterlab_student/labextension
 # Version file is handled by hatchling
-jupyterlab_eduhelx_submission/_version.py
+eduhelx_jupyterlab_student/_version.py
 
 # Integration tests
 ui-tests/test-results/
@@ -27,6 +27,15 @@ __pycache__/
 # C extensions
 *.so
 
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
 # Distribution / packaging
 .Python
 build/

.prettierignore

@@ -3,4 +3,4 @@ node_modules
 **/lib
 **/package.json
 !/package.json
-jupyterlab_eduhelx_submission
+eduhelx_jupyterlab_student

README.md

@@ -1,10 +1,10 @@
-# jupyterlab_eduhelx_submission
+# eduhelx-jupyterlab-student-ext (JLS-ext)
 
-[![Github Actions Status](https://github.com/helxplatform/jupyterlab_eduhelx_submission/workflows/Build/badge.svg)](https://github.com/helxplatform/jupyterlab_eduhelx_submission/actions/workflows/build.yml)
+[![Github Actions Status](https://github.com/helxplatform/eduhelx_jupyterlab_student/workflows/Build/badge.svg)](https://github.com/helxplatform/eduhelx_jupyterlab_student/actions/workflows/build.yml)
 A JupyterLab extension for managing assignments/submissions in EduHeLx
 
-This extension is composed of a Python package named `jupyterlab_eduhelx_submission`
-for the server extension and a NPM package named `jupyterlab_eduhelx_submission`
+This extension is composed of a Python package named `eduhelx_jupyterlab_student`
+for the server extension and a NPM package named `eduhelx_jupyterlab_student`
 for the frontend extension.
 
 ## Requirements
@@ -16,15 +16,15 @@ for the frontend extension.
 To install the extension, execute:
 
 ```bash
-pip install jupyterlab_eduhelx_submission
+pip install eduhelx_jupyterlab_student
 ```
 
 ## Uninstall
 
 To remove the extension, execute:
 
 ```bash
-pip uninstall jupyterlab_eduhelx_submission
+pip uninstall eduhelx_jupyterlab_student
 ```
 
 ## Troubleshoot
@@ -56,13 +56,13 @@ The `jlpm` command is JupyterLab's pinned version of
 Installing the extension
 ```bash
 # Clone the repo to your local environment
-# Change directory to the jupyterlab_eduhelx_submission directory
+# Change directory to the eduhelx_jupyterlab_student directory
 # Install package in development mode
 pip install -ve ".[test]"
 # Link your development version of the extension with JupyterLab
 jupyter labextension develop . --overwrite
 # Server extension must be manually installed in develop mode
-jupyter server extension enable jupyterlab_eduhelx_submission
+jupyter server extension enable eduhelx_jupyterlab_student
 ```
 
 Frontend Development (after install)
@@ -90,13 +90,13 @@ jupyter lab build --minimize=False
 
 ```bash
 # Server extension must be manually disabled in develop mode
-jupyter server extension disable jupyterlab_eduhelx_submission
-pip uninstall jupyterlab_eduhelx_submission
+jupyter server extension disable eduhelx_jupyterlab_student
+pip uninstall eduhelx_jupyterlab_student
 ```
 
 In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
 command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
-folder is located. Then you can remove the symlink named `jupyterlab_eduhelx_submission` within that folder.
+folder is located. Then you can remove the symlink named `eduhelx_jupyterlab_student` within that folder.
 
 ### Testing the extension
 
@@ -115,7 +115,7 @@ jupyter labextension develop . --overwrite
 To execute them, run:
 
 ```sh
-pytest -vv -r ap --cov jupyterlab_eduhelx_submission
+pytest -vv -r ap --cov eduhelx_jupyterlab_student
 ```
 
 #### Frontend tests

RELEASE.md

@@ -1,4 +1,4 @@
-# Making a new release of jupyterlab_eduhelx_submission
+# Making a new release of eduhelx_jupyterlab_student
 
 The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
 

conftest.py

@@ -8,7 +8,7 @@ def jp_server_config(jp_server_config):
     return {
         "ServerApp": {
             "jpserver_extensions": {
-                "jupyterlab_eduhelx_submission": True
+                "eduhelx_jupyterlab_student": True
             }
         }
     }

jupyterlab_eduhelx_submission/__init__.py → eduhelx_jupyterlab_student/__init__.py

@@ -6,13 +6,13 @@
 def _jupyter_labextension_paths():
     return [{
         "src": "labextension",
-        "dest": "jupyterlab_eduhelx_submission"
+        "dest": "eduhelx_jupyterlab_student"
     }]
 
 
 def _jupyter_server_extension_points():
     return [{
-        "module": "jupyterlab_eduhelx_submission"
+        "module": "eduhelx_jupyterlab_student"
     }]
 
 
@@ -25,7 +25,7 @@ def _load_jupyter_server_extension(server_app: ServerApp):
         JupyterLab application instance
     """
     setup_handlers(server_app)
-    name = "jupyterlab_eduhelx_submission"
+    name = "eduhelx_jupyterlab_student"
     server_app.log.info(f"Registered {name} server extension")
 
 

jupyterlab_eduhelx_submission/api.py → eduhelx_jupyterlab_student/api.py

@@ -26,7 +26,7 @@ def __init__(self, config: Config):
         self.client = httpx.AsyncClient(
             base_url=f"{ self.api_url }api/v1/",
             headers={
-                "User-Agent": f"jupyter_eduhelx_extension/{ __version__ }"
+                "User-Agent": f"jls-ext/{ __version__ }"
             }
         )