jupyterlab_in_context_translation — jupyterlab-contrib 1.0.0 documentation (original) (raw)

A Jupyter extension to translate the web interface directly within the application using crowdin in-context. It works for both JupyterLab and Notebook.

Usage¶

No installation (recommended)¶

1. Create a free crowdin account
2. Join the JupyterLab crowdin project
3. To start translating
   1. JupyterLab: open this link
   2. Notebook: open this link

Local installation as Jupyter extension¶

1. Create a free crowdin account
2. Join the JupyterLab crowdin project
3. Install this extension: pip install jupytelab notebook jupyterlab_in_context_translation
4. Start JupyterLab (jupyter lab) or Notebook (jupyter notebook)
5. Pick the pseudo-language in the menu Settings -> Language
6. Acknowledge to save and reload the page
7. On reload, you will be prompted to pick the language you want to translate JupyterLab into and to log in crowdin
8. Start translating the string highlighted by a red border
   1. Hover the string to translate
   2. Click on the edit button that appear in the top left corner
   3. In the dialog, type the translation
   4. Click on Save button
9. To deactivate the feature, pick another language in the menu Settings -> Language

See also the video that illustrates those steps.

https://github.com/user-attachments/assets/bfe0e93b-d55c-4b29-a45e-e82f9aad3757

Requirements¶

• A free crowdin account
  • Then join to the JupyterLab project
• JupyterLab >= 4.0.0 or Notebook >= 7.0.0

Install¶

To install the extension, execute:

pip install jupyterlab_in_context_translation

Uninstall¶

To remove the extension, execute:

pip uninstall jupyterlab_in_context_translation

Contributing¶

Development install¶

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

The jlpm command is JupyterLab’s pinned version ofyarn that is installed with JupyterLab. You may useyarn or npm in lieu of jlpm below.

Clone the repo to your local environment

Change directory to the jupyterlab_in_context_translation 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 jupyterlab_in_context_translation

In development mode, you will also need to remove the symlink created by jupyter labextension developcommand. To find its location, you can run jupyter labextension list to figure out where the labextensionsfolder is located. Then you can remove the symlink named @jlab-contrib/in-context-translation within that folder.

Testing the extension¶

Frontend tests¶

This extension is using Jest for JavaScript code testing.

To execute them, execute:

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