Skip to main content

A small tweaks for SATySFi Notebook environment.

Project description

satysfi_notebook_tweaks

Github Actions Status Binder

A small tweaks for SATySFi Notebook environment.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install satysfi_notebook_tweaks

Uninstall

To remove the extension, execute:

pip uninstall satysfi_notebook_tweaks

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the satysfi_notebook_tweaks directory
# Install package in development mode
pip install -e "."
# 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 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 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:

jupyter lab build --minimize=False

Development uninstall

pip uninstall satysfi_notebook_tweaks

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 satysfi-notebook-tweaks within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

satysfi_notebook_tweaks-0.3.0.tar.gz (185.8 kB view details)

Uploaded Source

Built Distribution

satysfi_notebook_tweaks-0.3.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file satysfi_notebook_tweaks-0.3.0.tar.gz.

File metadata

File hashes

Hashes for satysfi_notebook_tweaks-0.3.0.tar.gz
Algorithm Hash digest
SHA256 01c390d0c7e5a738837cede909fb000e99ae9c8a14d997d9de7b61979f0e7875
MD5 8f0f224257dc0835aa0ce248d84dcbe3
BLAKE2b-256 1a8a7efc1280c1e3931b8682695fa6308898eda3cbb468532cfeedcb9d1a3a4f

See more details on using hashes here.

File details

Details for the file satysfi_notebook_tweaks-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for satysfi_notebook_tweaks-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 63fead09575b1b3b35945d4653e18d2b01eea6a30ada78f35095bd57f62ecb23
MD5 cec65d9947efedc3d52d9fff8c6aa060
BLAKE2b-256 d55e784cf5719f59c51bcfce788458c5bfdd615ecb1eeb7c82a3fed45c8644dd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page