jupyterlab-unianalytics-dashboard 4.0.6__tar.gz → 4.0.8__tar.gz

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/.copier-answers.yml

@@ -1,20 +1,20 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: v4.0.5
+_commit: v4.2.5
 _src_path: https://github.com/jupyterlab/extension-template
-author_email: me@test.com
+author_email: raphael.marietan@hotmail.com
 author_name: Raphael Marietan
 data_format: string
 file_extension: ''
 has_binder: true
 has_settings: true
-kind: frontend
+kind: server
 labextension_name: jupyterlab_unianalytics_dashboard
 mimetype: ''
 mimetype_name: ''
-project_short_description:
-  A JupyterLab dashboard extension to visualiaze data from
-  students.
+project_short_description: A JupyterLab dashboard extension to visualize data from
+    students.
 python_name: jupyterlab_unianalytics_dashboard
 repository: https://github.com/chili-epfl/jupyter-dashboard-visu-extension
 test: true
 viewer_name: ''
+

jupyterlab_unianalytics_dashboard-4.0.8/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/CHANGELOG.md

@@ -2,12 +2,23 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
-## 4.0.6
+## 4.0.8
 
-Fixed incompatibility with JupyterLab 3.
+No merged PRs
 
 <!-- <END NEW CHANGELOG ENTRY> -->
 
+## 4.0.7
+
+- Feature: adding text-based filtering in Cell dashboard
+- Adding server extension component
+- Generating or retrieving persistent user identifier
+- Small bug fixes
+
+## 4.0.6
+
+Fixed incompatibility with JupyterLab 3.
+
 ## 4.0.5
 
 Changes since last release:

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2023, Raphael Marietan
+Copyright (c) 2024, Raphael Marietan
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.1
 Name: jupyterlab_unianalytics_dashboard
-Version: 4.0.6
+Version: 4.0.8
 Summary: A JupyterLab dashboard extension to visualize data from students.
 Project-URL: Homepage, https://github.com/chili-epfl/jupyter-dashboard-visu-extension
 Project-URL: Bug Tracker, https://github.com/chili-epfl/jupyter-dashboard-visu-extension/issues
 Project-URL: Repository, https://github.com/chili-epfl/jupyter-dashboard-visu-extension.git
-Author-email: Raphael Marietan <me@test.com>
+Author-email: Raphael Marietan <raphael.marietan@hotmail.com>
 License: BSD 3-Clause License
         
-        Copyright (c) 2023, Raphael Marietan
+        Copyright (c) 2024, Raphael Marietan
         All rights reserved.
         
         Redistribution and use in source and binary forms, with or without
@@ -48,7 +48,15 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.8
+Requires-Dist: jupyter-server<3,>=1.12
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
 Description-Content-Type: text/markdown
 
 # Unianalytics Dashboard JupyterLab Extension
@@ -79,6 +87,22 @@ To remove the extension, execute:
 pip uninstall jupyterlab-unianalytics_dashboard
 ```
 
+## Troubleshoot
+
+If you are seeing the frontend extension, but it is not working, check
+that the server extension is enabled:
+
+```bash
+jupyter server extension list
+```
+
+If the server extension is installed and enabled, but you are not seeing
+the frontend extension, check the frontend extension is installed:
+
+```bash
+jupyter labextension list
+```
+
 ## Contributing
 
 ### Development install
@@ -91,11 +115,13 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the extension directory
+# Change directory to the jupyterlab_unianalytics_dashboard directory
 # Install package in development mode
-pip install -e "."
+pip install -e ".[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_unianalytics_dashboard
 # Rebuild extension Typescript source after making changes
 jlpm build
 ```
@@ -120,6 +146,8 @@ jupyter lab build --minimize=False
 ### Development uninstall
 
 ```bash
+# Server extension must be manually disabled in develop mode
+jupyter server extension disable jupyterlab_unianalytics_dashboard
 pip uninstall jupyterlab_unianalytics_dashboard
 ```
 
@@ -129,6 +157,24 @@ folder is located. Then you can remove the symlink named `jupyterlab_unianalytic
 
 ### Testing the extension
 
+#### Server tests
+
+This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
+
+Install test dependencies (needed only once):
+
+```sh
+pip install -e ".[test]"
+# Each time you install the Python package, you need to restore the front-end extension link
+jupyter labextension develop . --overwrite
+```
+
+To execute them, run:
+
+```sh
+pytest -vv -r ap --cov jupyterlab_unianalytics_dashboard
+```
+
 #### Frontend tests
 
 This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
@@ -142,7 +188,7 @@ jlpm test
 
 #### Integration tests
 
-This extension uses [Playwright](https://playwright.dev/docs/intro/) for the integration tests (aka user level tests).
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
 More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
 
 More information are provided within the [ui-tests](./ui-tests/README.md) README.

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/README.md

@@ -26,6 +26,22 @@ To remove the extension, execute:
 pip uninstall jupyterlab-unianalytics_dashboard
 ```
 
+## Troubleshoot
+
+If you are seeing the frontend extension, but it is not working, check
+that the server extension is enabled:
+
+```bash
+jupyter server extension list
+```
+
+If the server extension is installed and enabled, but you are not seeing
+the frontend extension, check the frontend extension is installed:
+
+```bash
+jupyter labextension list
+```
+
 ## Contributing
 
 ### Development install
@@ -38,11 +54,13 @@ The `jlpm` command is JupyterLab's pinned version of
 
 ```bash
 # Clone the repo to your local environment
-# Change directory to the extension directory
+# Change directory to the jupyterlab_unianalytics_dashboard directory
 # Install package in development mode
-pip install -e "."
+pip install -e ".[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_unianalytics_dashboard
 # Rebuild extension Typescript source after making changes
 jlpm build
 ```
@@ -67,6 +85,8 @@ jupyter lab build --minimize=False
 ### Development uninstall
 
 ```bash
+# Server extension must be manually disabled in develop mode
+jupyter server extension disable jupyterlab_unianalytics_dashboard
 pip uninstall jupyterlab_unianalytics_dashboard
 ```
 
@@ -76,6 +96,24 @@ folder is located. Then you can remove the symlink named `jupyterlab_unianalytic
 
 ### Testing the extension
 
+#### Server tests
+
+This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
+
+Install test dependencies (needed only once):
+
+```sh
+pip install -e ".[test]"
+# Each time you install the Python package, you need to restore the front-end extension link
+jupyter labextension develop . --overwrite
+```
+
+To execute them, run:
+
+```sh
+pytest -vv -r ap --cov jupyterlab_unianalytics_dashboard
+```
+
 #### Frontend tests
 
 This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
@@ -89,7 +127,7 @@ jlpm test
 
 #### Integration tests
 
-This extension uses [Playwright](https://playwright.dev/docs/intro/) for the integration tests (aka user level tests).
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
 More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
 
 More information are provided within the [ui-tests](./ui-tests/README.md) README.

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/RELEASE.md

@@ -64,7 +64,41 @@ Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/e
 
 Here is a summary of the steps to cut a new release:
 
-- Add `ADMIN_GITHUB_TOKEN`, `PYPI_TOKEN` and `NPM_TOKEN` to the [Github Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) in the repository
+- Add tokens to the [Github Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) in the repository:
+  - `ADMIN_GITHUB_TOKEN` (with "public_repo" and "repo:status" permissions); see the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+  - `NPM_TOKEN` (with "automation" permission); see the [documentation](https://docs.npmjs.com/creating-and-viewing-access-tokens)
+- Set up PyPI
+
+<details><summary>Using PyPI trusted publisher (modern way)</summary>
+
+- Set up your PyPI project by [adding a trusted publisher](https://docs.pypi.org/trusted-publishers/adding-a-publisher/)
+  - The _workflow name_ is `publish-release.yml` and the _environment_ should be left blank.
+- Ensure the publish release job as `permissions`: `id-token : write` (see the [documentation](https://docs.pypi.org/trusted-publishers/using-a-publisher/))
+
+</details>
+
+<details><summary>Using PyPI token (legacy way)</summary>
+
+- If the repo generates PyPI release(s), create a scoped PyPI [token](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#saving-credentials-on-github). We recommend using a scoped token for security reasons.
+
+- You can store the token as `PYPI_TOKEN` in your fork's `Secrets`.
+
+  - Advanced usage: if you are releasing multiple repos, you can create a secret named `PYPI_TOKEN_MAP` instead of `PYPI_TOKEN` that is formatted as follows:
+
+    ```text
+    owner1/repo1,token1
+    owner2/repo2,token2
+    ```
+
+    If you have multiple Python packages in the same repository, you can point to them as follows:
+
+    ```text
+    owner1/repo1/path/to/package1,token1
+    owner1/repo1/path/to/package2,token2
+    ```
+
+</details>
+
 - Go to the Actions panel
 - Run the "Step 1: Prep Release" workflow
 - Check the draft changelog

jupyterlab_unianalytics_dashboard-4.0.8/conftest.py

@@ -0,0 +1,8 @@
+import pytest
+
+pytest_plugins = ("pytest_jupyter.jupyter_server", )
+
+
+@pytest.fixture
+def jp_server_config(jp_server_config):
+    return {"ServerApp": {"jpserver_extensions": {"jupyterlab_unianalytics_dashboard": True}}}

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/junit.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<testsuites name="jest tests" tests="1" failures="0" errors="0" time="37.109">
-  <testsuite name="jupyterlab_unianalytics_dashboard" errors="0" failures="0" skipped="0" timestamp="2023-10-02T15:00:21" time="24.817" tests="1">
-    <testcase classname="jupyterlab_unianalytics_dashboard should be tested" name="jupyterlab_unianalytics_dashboard should be tested" time="0.006">
+<testsuites name="jest tests" tests="1" failures="0" errors="0" time="25.156">
+  <testsuite name="jupyterlab_unianalytics_dashboard" errors="0" failures="0" skipped="0" timestamp="2024-01-26T16:04:36" time="13.286" tests="1">
+    <testcase classname="jupyterlab_unianalytics_dashboard should be tested" name="jupyterlab_unianalytics_dashboard should be tested" time="0.005">
     </testcase>
   </testsuite>
 </testsuites>

jupyterlab_unianalytics_dashboard-4.0.8/jupyter-config/server-config/jupyterlab_unianalytics_dashboard.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "jupyterlab_unianalytics_dashboard": true
+    }
+  }
+}

jupyterlab_unianalytics_dashboard-4.0.8/jupyterlab_unianalytics_dashboard/__init__.py

@@ -0,0 +1,36 @@
+try:
+    from ._version import __version__
+except ImportError:
+    # Fallback when using the package in dev mode without installing
+    # in editable mode with pip. It is highly recommended to install
+    # the package from a stable release or in editable mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
+    import warnings
+    warnings.warn("Importing 'jupyterlab_unianalytics_dashboard' outside a proper installation.")
+    __version__ = "dev"
+from .handlers import setup_handlers
+
+
+def _jupyter_labextension_paths():
+    return [{
+        "src": "labextension",
+        "dest": "jupyterlab_unianalytics_dashboard"
+    }]
+
+
+def _jupyter_server_extension_points():
+    return [{
+        "module": "jupyterlab_unianalytics_dashboard"
+    }]
+
+
+def _load_jupyter_server_extension(server_app):
+    """Registers the API handler to receive HTTP requests from the frontend extension.
+
+    Parameters
+    ----------
+    server_app: jupyterlab.labapp.LabApp
+        JupyterLab application instance
+    """
+    setup_handlers(server_app.web_app)
+    name = "jupyterlab_unianalytics_dashboard"
+    server_app.log.info(f"Registered {name} server extension")

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/jupyterlab_unianalytics_dashboard/_version.py

@@ -1,4 +1,4 @@
 # This file is auto-generated by Hatchling. As such, do not:
 #   - modify
 #   - track in version control e.g. be sure to add to .gitignore
-__version__ = VERSION = '4.0.6'
+__version__ = VERSION = '4.0.8'

jupyterlab_unianalytics_dashboard-4.0.8/jupyterlab_unianalytics_dashboard/handlers.py

@@ -0,0 +1,53 @@
+import os
+import uuid
+from hashlib import sha256
+from jupyter_server.config_manager import BaseJSONConfigManager
+
+from jupyter_server.base.handlers import APIHandler
+from jupyter_server.utils import url_path_join
+import tornado
+
+SECRET_SALT = '5ea06c48dbb6a90cdee78f88b8a08e673efda3d28c8019e62e326ce817ee8900'
+def hash_user_id_with_salt(prehashed_id): 
+    return sha256(prehashed_id.encode('utf-8') + SECRET_SALT.encode('utf-8')).hexdigest()
+
+class RouteHandler(APIHandler):
+    # the following decorator should be present on all verb methods (head, get, post,
+    # patch, put, delete, options) to ensure only authorized user can request the
+    # Jupyter server
+    @tornado.web.authenticated
+    def get(self):
+        # return the anonymized user identifier
+        self.finish(self.anonymized_user_id)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # get the SCIPER identifier if available
+        user_id = os.getenv('JUPYTERHUB_USER')
+
+        if not user_id :
+            
+            # get randomly generated user_id from persisting config, and create one if not found
+            config_dir_path = os.path.join(os.path.expanduser('~'), '.jupyter/lab/user-settings/jupyterlab_unianalytics')
+            json_filename = 'unianalytics_user_info'
+
+            cm = BaseJSONConfigManager(config_dir=config_dir_path)
+            cm.ensure_config_dir_exists()
+
+            user_id = cm.get(json_filename).get('user_id')
+
+            if not user_id :
+                user_id = str(uuid.uuid4())
+                cm.set(json_filename, { 'user_id': user_id })
+
+        # anonymize the user_id
+        self.anonymized_user_id = hash_user_id_with_salt(user_id)
+
+def setup_handlers(web_app):
+    host_pattern = ".*$"
+
+    base_url = web_app.settings["base_url"]
+    route_pattern = url_path_join(base_url, "jupyterlab-unianalytics-dashboard", "get_anonymized_user_id")
+    handlers = [(route_pattern, RouteHandler)]
+    web_app.add_handlers(host_pattern, handlers)

{jupyterlab_unianalytics_dashboard-4.0.6 → jupyterlab_unianalytics_dashboard-4.0.8}/jupyterlab_unianalytics_dashboard/labextension/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab_unianalytics_dashboard",
-  "version": "4.0.6",
+  "version": "4.0.8",
   "description": "A JupyterLab dashboard extension to visualize data from students.",
   "keywords": [
     "jupyter",
@@ -14,11 +14,12 @@
   "license": "BSD-3-Clause",
   "author": {
     "name": "Raphael Marietan",
-    "email": "me@test.com"
+    "email": "raphael.marietan@hotmail.com"
   },
   "files": [
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
     "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "src/**/*.{ts,tsx}",
     "schema/*.json"
   ],
   "main": "lib/index.js",
@@ -58,16 +59,14 @@
   "dependencies": {
     "@juggle/resize-observer": "^3.4.0",
     "@jupyterlab/application": "^4.0.0",
-    "@jupyterlab/launcher": "^4.0.1",
+    "@jupyterlab/coreutils": "^6.0.0",
+    "@jupyterlab/services": "^7.0.0",
     "@jupyterlab/settingregistry": "^4.0.0",
-    "@jupyterlab/toc": "^6.0.2",
     "@reduxjs/toolkit": "^1.9.5",
-    "bootstrap": "^5.2.3",
-    "chart.js": "^4.3.0",
-    "crypto-js": "^4.1.1",
-    "jszip": "^3.10.1",
-    "marked": "^9.1.6",
-    "react-bootstrap": "^2.7.4",
+    "bootstrap": "^5.3.2",
+    "chart.js": "^4.4.1",
+    "marked": "^11.1.1",
+    "react-bootstrap": "^2.10.0",
     "react-bootstrap-icons": "^1.10.3",
     "react-chartjs-2": "^5.2.0",
     "react-redux": "^8.0.5"
@@ -75,29 +74,29 @@
   "devDependencies": {
     "@jupyterlab/builder": "^4.0.0",
     "@jupyterlab/testutils": "^4.0.0",
-    "@types/crypto-js": "^4.1.1",
     "@types/jest": "^29.2.0",
     "@types/json-schema": "^7.0.11",
     "@types/react": "^18.0.26",
-    "@types/react-dom": "^18.2.14",
-    "@types/uuid": "^9.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.55.0",
-    "@typescript-eslint/parser": "^5.55.0",
+    "@types/react-addons-linked-state-mixin": "^0.14.22",
+    "@types/react-dom": "^18.2.18",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
     "css-loader": "^6.7.1",
     "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.7.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^5.0.0",
     "jest": "^29.2.0",
+    "mkdirp": "^1.0.3",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.8.7",
-    "rimraf": "^4.4.1",
+    "prettier": "^3.0.0",
+    "rimraf": "^5.0.1",
     "source-map-loader": "^1.0.2",
     "style-loader": "^3.3.1",
-    "stylelint": "^14.9.1",
-    "stylelint-config-prettier": "^9.0.4",
-    "stylelint-config-recommended": "^8.0.0",
-    "stylelint-config-standard": "^26.0.0",
-    "stylelint-prettier": "^2.0.0",
+    "stylelint": "^15.10.1",
+    "stylelint-config-recommended": "^13.0.0",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-csstree-validator": "^3.0.0",
+    "stylelint-prettier": "^4.0.0",
     "typescript": "~5.0.2",
     "yjs": "^13.5.0"
   },
@@ -110,11 +109,21 @@
     "access": "public"
   },
   "jupyterlab": {
+    "discovery": {
+      "server": {
+        "managers": [
+          "pip"
+        ],
+        "base": {
+          "name": "jupyterlab_unianalytics_dashboard"
+        }
+      }
+    },
     "extension": true,
     "outputDir": "jupyterlab_unianalytics_dashboard/labextension",
     "schemaDir": "schema",
     "_build": {
-      "load": "static/remoteEntry.27b69645f536048bd908.js",
+      "load": "static/remoteEntry.8cd70c149b116f11f59e.js",
       "extension": "./extension",
       "style": "./style"
     }
@@ -186,7 +195,15 @@
     "singleQuote": true,
     "trailingComma": "none",
     "arrowParens": "avoid",
-    "endOfLine": "auto"
+    "endOfLine": "auto",
+    "overrides": [
+      {
+        "files": "package.json",
+        "options": {
+          "tabWidth": 4
+        }
+      }
+    ]
   },
   "stylelint": {
     "extends": [
@@ -194,11 +211,15 @@
       "stylelint-config-standard",
       "stylelint-prettier/recommended"
     ],
+    "plugins": [
+      "stylelint-csstree-validator"
+    ],
     "rules": {
+      "csstree/validator": true,
       "property-no-vendor-prefix": null,
+      "selector-class-pattern": "^([a-z][A-z\\d]*)(-[A-z\\d]+)*$",
       "selector-no-vendor-prefix": null,
-      "value-no-vendor-prefix": null,
-      "selector-class-pattern": null
+      "value-no-vendor-prefix": null
     }
   }
 }