jupyterlab-translate


Namejupyterlab-translate JSON
Version 1.3.7 PyPI version JSON
download
home_pageNone
SummaryJupyterLab Language Pack Translations Helper
upload_time2024-05-15 12:27:52
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseCopyright (c) 2020 Project Jupyter Contributors 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.
keywords hatch jupyterlab language localization
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # jupyterlab-translate

![Linux tests](https://github.com/jupyterlab/jupyterlab-translate/workflows/Run%20tests/badge.svg)
[![license](https://img.shields.io/pypi/l/jupyterlab-translate.svg)](./LICENSE.txt)
[![pypi version](https://img.shields.io/pypi/v/jupyterlab-translate.svg)](https://pypi.org/project/jupyterlab-translate/)
[![conda version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-translate.svg)](https://www.anaconda.org/conda-forge/jupyterlab-translate)
[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Join the chat at https://gitter.im/jupyterlab/jupyterlab](https://badges.gitter.im/jupyterlab/jupyterlab.svg)](https://gitter.im/jupyterlab/jupyterlab)

This package is used to generate [language packs](https://github.com/jupyterlab/language-packs) for the JupyterLab ecosystem.

This package performs the following tasks common on JupyterLab core and external extensions:

* Extract strings from code in `*.py`, `*.ts`, `*.tsx` files.
* Extract strings from JSON schema files.
* Create gettext `*.pot` catalogs.
* Removes duplicate strings from catalogs.
* Create gettext `*.po` catalogs for specific languages.
* Compile catalogs to `*.mo` and `*.json` format to be consumed by the JupyterLab frontend.
* Provide a [Hatch Build Hook](https://hatch.pypa.io/latest/plugins/build-hook/reference/) to compile catalogs when building wheels.
* Update the list of contributors from Crowdin project.

## Installation

### Pip

```bash
pip install jupyterlab-translate
```

You will also need to install `nodejs` >= 14.

### Conda

```bash
conda install jupyterlab-translate -c conda-forge
```

## Usage

### Bundle catalogs as part of a language pack

This is the recommended way of distributing your localization catalogs.

Visit the [language packs repository](https://github.com/jupyterlab/language-packs).

### Bundle catalogs with packages

```bash
jupyterlab-translate extract <JLAB-EXTENSION-DIR> <JLAB-EXTENSION-NAME>
jupyterlab-translate update <JLAB-EXTENSION-DIR> <JLAB-EXTENSION-NAME> -l es_ES
jupyterlab-translate compile <JLAB-EXTENSION-DIR> <JLAB-EXTENSION-NAME>
```

## Development

### Typescript extractor

To extract translatable strings from typescript files, this package relies on
[`gettext-extract`](https://github.com/sinedied/gettext-extract). To ease its
installation and usage, that tool is packaged within the python package by
creating a monolithic JavaScript file using [`@vercel/ncc`](https://github.com/vercel/ncc)
_compiler_.

To update the monolithic file, have a look at the [release file](./RELEASE.md).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jupyterlab-translate",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "hatch, jupyterlab, language, localization",
    "author": null,
    "author_email": "Project Jupyter Contributors <jupyter@googlegroups.com>",
    "download_url": "https://files.pythonhosted.org/packages/08/26/0e147d6fa8051b40b5e8db367f64aa383c7ea982205f3e776ec32e3b3fa0/jupyterlab_translate-1.3.7.tar.gz",
    "platform": null,
    "description": "# jupyterlab-translate\n\n![Linux tests](https://github.com/jupyterlab/jupyterlab-translate/workflows/Run%20tests/badge.svg)\n[![license](https://img.shields.io/pypi/l/jupyterlab-translate.svg)](./LICENSE.txt)\n[![pypi version](https://img.shields.io/pypi/v/jupyterlab-translate.svg)](https://pypi.org/project/jupyterlab-translate/)\n[![conda version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-translate.svg)](https://www.anaconda.org/conda-forge/jupyterlab-translate)\n[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Join the chat at https://gitter.im/jupyterlab/jupyterlab](https://badges.gitter.im/jupyterlab/jupyterlab.svg)](https://gitter.im/jupyterlab/jupyterlab)\n\nThis package is used to generate [language packs](https://github.com/jupyterlab/language-packs) for the JupyterLab ecosystem.\n\nThis package performs the following tasks common on JupyterLab core and external extensions:\n\n* Extract strings from code in `*.py`, `*.ts`, `*.tsx` files.\n* Extract strings from JSON schema files.\n* Create gettext `*.pot` catalogs.\n* Removes duplicate strings from catalogs.\n* Create gettext `*.po` catalogs for specific languages.\n* Compile catalogs to `*.mo` and `*.json` format to be consumed by the JupyterLab frontend.\n* Provide a [Hatch Build Hook](https://hatch.pypa.io/latest/plugins/build-hook/reference/) to compile catalogs when building wheels.\n* Update the list of contributors from Crowdin project.\n\n## Installation\n\n### Pip\n\n```bash\npip install jupyterlab-translate\n```\n\nYou will also need to install `nodejs` >= 14.\n\n### Conda\n\n```bash\nconda install jupyterlab-translate -c conda-forge\n```\n\n## Usage\n\n### Bundle catalogs as part of a language pack\n\nThis is the recommended way of distributing your localization catalogs.\n\nVisit the [language packs repository](https://github.com/jupyterlab/language-packs).\n\n### Bundle catalogs with packages\n\n```bash\njupyterlab-translate extract <JLAB-EXTENSION-DIR> <JLAB-EXTENSION-NAME>\njupyterlab-translate update <JLAB-EXTENSION-DIR> <JLAB-EXTENSION-NAME> -l es_ES\njupyterlab-translate compile <JLAB-EXTENSION-DIR> <JLAB-EXTENSION-NAME>\n```\n\n## Development\n\n### Typescript extractor\n\nTo extract translatable strings from typescript files, this package relies on\n[`gettext-extract`](https://github.com/sinedied/gettext-extract). To ease its\ninstallation and usage, that tool is packaged within the python package by\ncreating a monolithic JavaScript file using [`@vercel/ncc`](https://github.com/vercel/ncc)\n_compiler_.\n\nTo update the monolithic file, have a look at the [release file](./RELEASE.md).\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2020 Project Jupyter Contributors 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.",
    "summary": "JupyterLab Language Pack Translations Helper",
    "version": "1.3.7",
    "project_urls": {
        "homepage": "https://github.com/jupyterlab/jupyterlab-translate"
    },
    "split_keywords": [
        "hatch",
        " jupyterlab",
        " language",
        " localization"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa07482a62cb87e71d1d624369d1ef94b41cf22ee72167ad5e2f67b3d051880b",
                "md5": "83aabfda9b5f31a793b3839607118ede",
                "sha256": "a88384e888b203dbee78754c205c7bb06dad882cde220ad4e55af6c246c2ef13"
            },
            "downloads": -1,
            "filename": "jupyterlab_translate-1.3.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "83aabfda9b5f31a793b3839607118ede",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 854868,
            "upload_time": "2024-05-15T12:27:50",
            "upload_time_iso_8601": "2024-05-15T12:27:50.461881Z",
            "url": "https://files.pythonhosted.org/packages/fa/07/482a62cb87e71d1d624369d1ef94b41cf22ee72167ad5e2f67b3d051880b/jupyterlab_translate-1.3.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08260e147d6fa8051b40b5e8db367f64aa383c7ea982205f3e776ec32e3b3fa0",
                "md5": "0e14a396fc13824d0777664357cbe860",
                "sha256": "ce1663e5fc43456d345800e74fdc1023d3f4d1afa88d62b1e836b7342a4a0c61"
            },
            "downloads": -1,
            "filename": "jupyterlab_translate-1.3.7.tar.gz",
            "has_sig": false,
            "md5_digest": "0e14a396fc13824d0777664357cbe860",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 857155,
            "upload_time": "2024-05-15T12:27:52",
            "upload_time_iso_8601": "2024-05-15T12:27:52.044339Z",
            "url": "https://files.pythonhosted.org/packages/08/26/0e147d6fa8051b40b5e8db367f64aa383c7ea982205f3e776ec32e3b3fa0/jupyterlab_translate-1.3.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-15 12:27:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jupyterlab",
    "github_project": "jupyterlab-translate",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jupyterlab-translate"
}
        
Elapsed time: 3.25925s