معرفی شرکت ها


cate-jl-ext-0.1.2


Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر

توضیحات

Cate JupyterLab extension
ویژگی مقدار
سیستم عامل -
نام فایل cate-jl-ext-0.1.2
نام cate-jl-ext
نسخه کتابخانه 0.1.2
نگهدارنده []
ایمیل نگهدارنده []
نویسنده -
ایمیل نویسنده Norman Fomferra <norman.fomferra@brockmann-consult.de>
آدرس صفحه اصلی -
آدرس اینترنتی https://pypi.org/project/cate-jl-ext/
مجوز BSD 3-Clause License Copyright (c) 2023, Norman Fomferra 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.
# cate_jl_ext [![Github Actions Status](https://github.com/github_username/cate-jl-ext/workflows/Build/badge.svg)](https://github.com/github_username/cate-jl-ext/actions/workflows/build.yml) Cate JupyterLab extension This extension allows running Cate App within JupyterLab. The extension is composed of a Python package named `cate_jl_ext` for the server extension and a NPM package named `cate-jl-ext` for the frontend extension. --- **NOTE** This extension is still experimental and has neither been packaged nor deployed. Refer to the section **Development** below for dev installs. --- ## Requirements - JupyterLab >= 3.0 - cate >= 3.1.4 ## Install To install the extension, execute: ```bash pip install cate_jl_ext ``` ## Uninstall To remove the extension, execute: ```bash pip uninstall cate_jl_ext ``` ## Troubleshoot If you are seeing the frontend extension, but it is not working, check that the server extension is enabled: ```bash jupyter server extension list ``` If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed: ```bash jupyter labextension list ``` ## Development ### Setup environment Make sure to have a source installation of [cate](https://github.com/CCI-Tools/cate) in a dedicated Python environment. ```bash cd ${projects} git clone https://github.com/CCI-Tools/cate.git cd cate mamba env create ``` Activate `cate` environment and install cate in editable (development) mode: ```bash conda activate cate pip install -ve . ``` Update environment with required packages for building and running the JupyterLab extension. Note, the version of the `jupyterlab` in our development environment should match the version of the target system. We also install `jupyter-server-proxy`. ```bash mamba install -c conda-forge -c nodefaults jupyterlab jupyter-server-proxy ``` Also install some packaging and build tools: ```bash mamba install -c conda-forge -c nodefaults nodejs jupyter-packaging pip install build ``` Refer also to the [JupyterLab Extension Tutorial](https://jupyterlab.readthedocs.io/en/stable/extension/extension_tutorial.html) for the use these tools. ### Install extension from sources Make sure, `xcube` environment is active: ```bash conda activate xcube ``` Clone Cate JupyterLab extension repository next to the `cate` source folder: ```bash cd ${projects} git clone https://github.com/CCI-Tools/cate-jl-ext.git cd cate-jl-ext ``` Install the initial project dependencies and install the extension into the JupyterLab environment. Copy the frontend part of the extension into JupyterLab. We can run this pip install command again every time we make a change to copy the change into JupyterLab. ```bash pip install -ve . ``` Create a symbolic link from JupyterLab to our source directory. This means our changes are automatically available in JupyterLab: ```bash jupyter labextension develop --overwrite . ``` If successful, we can run JupyterLab and check if the extension works as expected: ```bash jupyter lab ``` ### Build after changes Run the following to rebuild the extension. This will be required after any changes of `package.json` or changes of frontend TypeScript files and other resources. ```bash jlpm run build ``` If you wish to avoid building after each change, you can run the ```bash jlpm run watch ``` from your extension directory in another terminal. This will automatically compile the TypeScript files as they are changed and saved. ## Contributing ### 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` in lieu of `jlpm` below. ```bash # Clone the repo to your local environment # Change directory to the cate_jl_ext directory # Install package in development mode pip install -e ".[test]" # Link your development version of the extension with JupyterLab jupyter labextension develop . --overwrite # Server extension must be manually installed in develop mode jupyter server extension enable cate_jl_ext # 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. ```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 # Server extension must be manually disabled in develop mode jupyter server extension disable cate_jl_ext pip uninstall cate_jl_ext ``` 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 `cate-jl-ext` within that folder. ### Testing the extension #### Server tests This extension is using [Pytest](https://docs.pytest.org/) for Python code testing. Install test dependencies (needed only once): ```sh pip install -e ".[test]" # Each time you install the Python package, you need to restore the front-end extension link jupyter labextension develop . --overwrite ``` To execute them, run: ```sh pytest -vv -r ap --cov cate_jl_ext ``` #### Frontend tests This extension is using [Jest](https://jestjs.io/) for JavaScript code testing. To execute them, execute: ```sh jlpm jlpm test ``` #### Integration tests This extension uses [Playwright](https://playwright.dev/docs/intro/) for the integration tests (aka user level tests). More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab. More information are provided within the [ui-tests](./ui-tests/README.md) README. ### Packaging the extension See [RELEASE](RELEASE.md)


نیازمندی

مقدار نام
- jupyter-server<3,>=1.21
xtr coverage;
xtr pytest;
xtr pytest-asyncio;
xtr pytest-cov;
xtr pytest-jupyter[server]>=0.6.0;


زبان مورد نیاز

مقدار نام
>=3.7 Python


نحوه نصب


نصب پکیج whl cate-jl-ext-0.1.2:

    pip install cate-jl-ext-0.1.2.whl


نصب پکیج tar.gz cate-jl-ext-0.1.2:

    pip install cate-jl-ext-0.1.2.tar.gz