jupyter-ascend-theme 0.2.0__tar.gz

jupyter_ascend_theme-0.2.0/.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.4.0
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: davide.giorgiutti@cgi.com
+author_name: Davide Giorgiutti
+has_binder: false
+has_settings: false
+kind: theme
+labextension_name: jupyter_ascend_theme
+project_short_description: The JupyterLab ASCEND theme
+python_name: jupyter_ascend_theme
+repository: ''
+test: false
+

jupyter_ascend_theme-0.2.0/.gitignore

@@ -0,0 +1,121 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyter_ascend_theme/labextension
+# Version file is handled by hatchling
+jupyter_ascend_theme/_version.py
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/

jupyter_ascend_theme-0.2.0/.gitlab-ci.yml

@@ -0,0 +1,112 @@
+# The development and release of this extension rely on a specific development and build environment.
+# Furthermore, the extension is linked to (and tested) with a specific version of JupyterLab (or a range of versions).
+# While the extension can be built and published from the local machine, this project pipeline ensures that the build environment
+# remains consistent and targets the correct JupyterLab version.
+image: node:20.12.2
+
+cache:
+  untracked: true
+  key:
+    files:
+      - yarn.lock
+      - package.json
+  paths:
+    - node_modules/
+  policy: pull-push
+
+stages:
+  - setup
+  - build
+  - test
+  - release
+
+install_dependencies:
+  stage: setup
+  script:
+    - echo "🔄 Updating system packages..."
+    - apt-get update && apt-get install -y python3 python3-pip python3-venv
+    - echo "🐍 Setting up Python virtual environment..."
+    - python3 -m venv .venv
+    - . .venv/bin/activate
+    - echo "⬆️ Upgrading pip..."
+    - python -m pip install --upgrade pip
+    - echo "📦 Installing JupyterLab dependencies..."
+    - python -m pip install -U "jupyterlab>=4.0.0,<5"
+    - echo "📦 Installing JavaScript dependencies..."
+    - jlpm install
+    - echo "⬆️ Installing additional Python dependencies..."
+    - python -m pip install --upgrade hatchling hatch_jupyter_builder
+    - python -m pip install .[test]
+
+build:
+  stage: build
+  needs: [install_dependencies]
+  artifacts:
+    paths:
+      - 'dist'
+    expire_in: 1 hr
+  script:
+    - echo "⚙️ Activating Python virtual environment..."
+    - . .venv/bin/activate
+    - echo "🛠️ Building the extension..."
+    - jlpm build
+
+eslint:
+  stage: test
+  needs: [install_dependencies]
+  script:
+    - echo "🔍 Running ESLint checks..."
+    - . .venv/bin/activate
+    - jlpm run eslint:check
+
+prettier:
+  stage: test
+  needs: [install_dependencies]
+  script:
+    - echo "✨ Checking code formatting with Prettier..."
+    - . .venv/bin/activate
+    - jlpm run prettier:check
+
+stylelint:
+  stage: test
+  needs: [install_dependencies]
+  script:
+    - echo "🎨 Running Stylelint checks..."
+    - . .venv/bin/activate
+    - jlpm run stylelint:check
+
+bump_version_and_release:
+  stage: release
+  needs: [install_dependencies, build]
+  script:
+    - echo "🔄 Updating system packages..."
+    - apt-get update && apt-get install -y python3 python3-pip python3-venv
+    - echo "🐍 Setting up Python virtual environment..."
+    - python3 -m venv .venv
+    - . .venv/bin/activate
+    - echo "⬆️ Upgrading pip..."
+    - python -m pip install --upgrade pip
+    - echo "📦 Installing necessary dependencies for release..."
+    - pip install twine hatch build
+    - echo "🔧 Configuring Git for release..."
+    - git config user.email "davide.giorgiutti@cgi.com@$CI_SERVER_HOST"
+    - git config user.name "cgi-bot"
+    - echo "⬇️ Pulling latest changes and rebasing..."
+    - git pull "https://project_access_token_name:$PROJECT_VARIABLE_WITH_ACCESS_TOKEN_VALUE@$CI_SERVER_HOST/$CI_PROJECT_PATH.git" $CI_COMMIT_BRANCH --rebase --autostash
+    - echo "🔢 Bumping extension version..."
+    - hatch version minor
+    - CURRENT_VERSION=$(hatch version)
+    - python -c "import json; data = json.load(open('package.json')); data['version'] = '$CURRENT_VERSION'; json.dump(data, open('package.json', 'w'), indent=4)"
+    - git status
+    - git add package.json
+    - git commit -m "cgi-bot:release extension version to $(hatch version) [ci skip]"
+    - echo "⬆️ Pushing version bump to repository..."
+    - git push "https://project_access_token_name:$PROJECT_VARIABLE_WITH_ACCESS_TOKEN_VALUE@$CI_SERVER_HOST/$CI_PROJECT_PATH.git" HEAD:$CI_COMMIT_BRANCH -o ci.skip
+    - echo "📦 Building package for release..."
+    - python -m build
+    - echo "🚀 Uploading package to PyPI..."
+    - twine upload dist/*
+    - jlpm clean:all
+    - git clean -dfX
+  # only:
+  #   - master

jupyter_ascend_theme-0.2.0/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+jupyter_ascend_theme

jupyter_ascend_theme-0.2.0/.yarnrc.yml

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

jupyter_ascend_theme-0.2.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

jupyter_ascend_theme-0.2.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Davide Giorgiutti
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jupyter_ascend_theme-0.2.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: jupyter_ascend_theme
+Version: 0.2.0
+Dynamic: Project-URL
+Summary: The JupyterLab ASCEND theme
+Author-email: Davide Giorgiutti <davide.giorgiutti@cgi.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, Davide Giorgiutti
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: CGI,jupyter,jupyterlab,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Themes
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# jupyter_ascend_theme <https://pypi.org/project/jupyter-ascend-theme/>
+
+The JupyterLab ASCEND theme.
+An extension for JupyterLab, published as a PIP package, adds two ASCEND-branded themes (light and dark) and some UI elements.
+
+This project was initialized using a copier template for Jupyterlab extensions: <https://github.com/jupyterlab/extension-template>.
+
+## Development Requirements
+
+To initialize a working development environment, ensure you have the following installed on your machine:
+
+- Node
+- npm
+- Yarn
+- pip
+- Python
+- JupyterLab
+
+The tested development environment uses the following versions:
+
+- Node: 20.12.2
+- npm: 10.5.0
+- pip: 24.2
+- Python: 3.11.3
+- JupyterLab: 4.2.4
+
+The template used to create this extension suggests using:
+
+- JupyterLab >= 4.0.0
+
+## Install the published package (production use)
+
+⚠️ **Note:** Your extensions may break with new releases of JupyterLab. As noted in Backwards Compatibility, Versions and Breaking Changes, JupyterLab development and release cycles follow semantic versioning, so we recommend planning your development process to account for possible future breaking changes that may disrupt users of your extensions. Consider documenting your maintenance plans to users in your project, or setting an upper bound on the version of JupyterLab your extension is compatible with in your project’s package metadata.
+
+<https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html>
+
+To install the extension, execute:
+
+```bash
+pip install jupyter_ascend_theme
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyter_ascend_theme
+```
+
+## Development
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab.
+
+You may use `yarn` or `npm` instead of `jlpm` below.
+
+```bash
+# Clone the repository to your local environment
+git clone https://gitlab.dev.eoss-cloud.it/cgi-italy/poieo/uis/jupyter-ascend-theme.git
+
+# Change directory to the repository directory
+cd jupyter-ascend-theme
+
+# Install python packages in development mode
+pip install -e "."
+
+# Install js packages
+jlpm install
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab simultaneously in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With 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, the `jlpm build` command 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:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyter_ascend_theme
+```
+
+In development mode, you will also need to remove the symlink created by the `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 `jupyter-ascend-theme` within that folder.
+
+## Packaging and releasing the extension
+
+See [RELEASE](RELEASE.md)

jupyter_ascend_theme-0.2.0/README.md

@@ -0,0 +1,109 @@
+# jupyter_ascend_theme <https://pypi.org/project/jupyter-ascend-theme/>
+
+The JupyterLab ASCEND theme.
+An extension for JupyterLab, published as a PIP package, adds two ASCEND-branded themes (light and dark) and some UI elements.
+
+This project was initialized using a copier template for Jupyterlab extensions: <https://github.com/jupyterlab/extension-template>.
+
+## Development Requirements
+
+To initialize a working development environment, ensure you have the following installed on your machine:
+
+- Node
+- npm
+- Yarn
+- pip
+- Python
+- JupyterLab
+
+The tested development environment uses the following versions:
+
+- Node: 20.12.2
+- npm: 10.5.0
+- pip: 24.2
+- Python: 3.11.3
+- JupyterLab: 4.2.4
+
+The template used to create this extension suggests using:
+
+- JupyterLab >= 4.0.0
+
+## Install the published package (production use)
+
+⚠️ **Note:** Your extensions may break with new releases of JupyterLab. As noted in Backwards Compatibility, Versions and Breaking Changes, JupyterLab development and release cycles follow semantic versioning, so we recommend planning your development process to account for possible future breaking changes that may disrupt users of your extensions. Consider documenting your maintenance plans to users in your project, or setting an upper bound on the version of JupyterLab your extension is compatible with in your project’s package metadata.
+
+<https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html>
+
+To install the extension, execute:
+
+```bash
+pip install jupyter_ascend_theme
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyter_ascend_theme
+```
+
+## Development
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of [yarn](https://yarnpkg.com/) that is installed with JupyterLab.
+
+You may use `yarn` or `npm` instead of `jlpm` below.
+
+```bash
+# Clone the repository to your local environment
+git clone https://gitlab.dev.eoss-cloud.it/cgi-italy/poieo/uis/jupyter-ascend-theme.git
+
+# Change directory to the repository directory
+cd jupyter-ascend-theme
+
+# Install python packages in development mode
+pip install -e "."
+
+# Install js packages
+jlpm install
+
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab simultaneously in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With 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, the `jlpm build` command 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:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyter_ascend_theme
+```
+
+In development mode, you will also need to remove the symlink created by the `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 `jupyter-ascend-theme` within that folder.
+
+## Packaging and releasing the extension
+
+See [RELEASE](RELEASE.md)

jupyter_ascend_theme-0.2.0/RELEASE.md

@@ -0,0 +1,84 @@
+# Making a new release of jupyter_ascend_theme
+
+The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+⚠️ **Note:** The development and release of this extension rely on a specific development and build environment.
+Furthermore, the extension is linked to (and tested) with a specific version of JupyterLab (or a range of versions).
+While the extension can be built and published from the local machine, this project pipeline ('.gitlab-ci.yaml') ensures that the build environment remains consistent and targets the correct JupyterLab version.
+
+## Manual release
+
+### Python package
+
+This extension can be distributed as Python packages. All of the Python
+packaging instructions are in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, you first need to install some tools:
+
+```bash
+pip install build twine hatch
+```
+
+Bump the version using `hatch`. By default this will create a tag.
+See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
+
+```bash
+hatch version <new-version>
+```
+
+Make sure to clean up all the development files before building the package:
+
+```bash
+jlpm clean:all
+```
+
+You could also clean up the local git repository:
+
+```bash
+git clean -dfX
+```
+
+To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
+
+```bash
+python -m build
+```
+
+> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
+
+Then to upload the package to PyPI, do:
+
+```bash
+twine upload dist/*
+```
+
+### NPM package
+
+To publish the frontend part of the extension as a NPM package, do:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser. But
+the GitHub repository and the package managers need to be properly set up. Please
+follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
+
+Here is a summary of the steps to cut a new release:
+
+- Go to the Actions panel
+- Run the "Step 1: Prep Release" workflow
+- Check the draft changelog
+- Run the "Step 2: Publish Release" workflow
+
+> [!NOTE]
+> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
+> for more information.
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: <https://conda-forge.org/docs/maintainer/adding_pkgs.html>
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

jupyter_ascend_theme-0.2.0/install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "jupyter_ascend_theme",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package jupyter_ascend_theme"
+}

jupyter_ascend_theme-0.2.0/jupyter_ascend_theme/__init__.py

@@ -0,0 +1,16 @@
+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 'jupyter_ascend_theme' outside a proper installation.")
+    __version__ = "dev"
+
+
+def _jupyter_labextension_paths():
+    return [{
+        "src": "labextension",
+        "dest": "jupyter_ascend_theme"
+    }]

jupyter_ascend_theme-0.2.0/jupyter_ascend_theme/_version.py

@@ -0,0 +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 = '0.2.0'