https://github.com/jupyterlab/language-packs

Language packs for JupyterLab ecosystem
https://github.com/jupyterlab/language-packs

Last synced: 22 days ago
JSON representation

Language packs for JupyterLab ecosystem

• Host: GitHub
• URL: https://github.com/jupyterlab/language-packs
• Owner: jupyterlab
• License: bsd-3-clause
• Created: 2020-06-27T00:17:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T09:48:06.000Z (7 months ago)
• Last Synced: 2024-05-22T10:51:26.875Z (7 months ago)
• Language: Python
• Size: 24.2 MB
• Stars: 73
• Watchers: 11
• Forks: 28
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-fe-resources - language-packs

README

        
# Jupyterlab Language Packs

[![Crowdin](https://badges.crowdin.net/jupyterlab/localized.svg)](https://crowdin.com/project/jupyterlab)

Jupyterlab language packs.

## Install

To install a specific language pack please see the [available packs](https://github.com/jupyterlab/language-packs/tree/master/language-packs).

> [!WARNING]

> The package `jupyterlab-language-pack-ach-UG` purpose is to allow translation of strings directly within JupyterLab using

> the [in-context Crowdin feature](https://developer.crowdin.com/in-context-localization/). You should not install it

> explicitly as it contains unmeaningful translation.

## Adding a new extension

Follow the instructions described in the [developer documentation](https://jupyterlab.readthedocs.io/en/stable/extension/internationalization.html) of JupyterLab.

Create a PR adding a new entry to the [repository-map.yml](https://github.com/jupyterlab/language-packs/blob/master/repository-map.yml) file.

```yaml

# Packages in alphabetical order

dask-labextension:

  current-version-tag: 5.0.2

  supported-versions: 5.0.x

  url: https://github.com/dask/dask-labextension

jupyterlab:

  current-version-tag: v3.1.14

  supported-versions: 3.1.x

  url: https://github.com/jupyterlab/jupyterlab

jupyterlab-git:

  current-version-tag: v0.32.4

  supported-versions: '>=0.30.0 <0.40.0'

  url: https://github.com/jupyterlab/jupyterlab-git

```

The three entries required are:

- `current-version-tag`: The latest Git tag to consider as reference for the package.

- `supported-versions`: A semver range (npm syntax) of supported versions.

- `url`: Git repository URL (only HTTP on GitHub is supported).

The current tag is used by a bot to check for new GitHub release. If one is detected, it

will bump the tag and open a PR to add this change.

The source strings are gathered for multiple versions matching the `supported-versions` range.

The list of versions included is computed as follow:

1. Get the last 100 tags from the GitHub repository

2. Check if the tag is a parsable non-dev non-prerelease version (parsing is done using Python function `packaging.version.parse`)

3. Check that the tag is part of the supported range(s)

> The `current-version-tag` can be a _branch_ name (not recommended). In such a case, `supported-versions` has

> no effect and the source strings are only extracted from the current branch HEAD commit (no merging with the

> previous POT file).

After the PR is merged, our bot will create/update the `.pot` files in a subsequent PR. Once merged, the catalog for the new extension will be available on [Crowdin](https://crowdin.com/project/jupyterlab).

When translations are completed for a given set of packages a new language pack for the given language will be released as python packages via [PyPI](https://pypi.org/) and conda packages via [conda-forge](https://conda-forge.org/).

## Contributing

Please visit [Crowdin](https://crowdin.com/project/jupyterlab) to contribute to a language pack.

## Important note

The language Acholi (ach-UG) is a pseudo-language to enable translating the string

withing JupyterLab through the [_in-context_ Crowdin feature](https://developer.crowdin.com/in-context-localization/).