| Name | elyra JSON |
| Version |
3.15.0
JSON |
| download |
| home_page | |
| Summary | Elyra provides AI Centric extensions to JupyterLab |
| upload_time | 2023-03-29 00:26:49 |
| maintainer | Elyra Maintainers |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--
{% comment %}
Copyright 2018-2022 Elyra Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
{% endcomment %}
-->
[](https://badge.fury.io/py/elyra)
[](https://anaconda.org/conda-forge/elyra)
[](https://pepy.tech/project/elyra)
[](https://elyra.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/elyra-ai/elyra/issues)
[](https://bestpractices.coreinfrastructure.org/projects/5761)
[](https://gitter.im/elyra-ai/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
# Elyra
Elyra is a set of AI-centric extensions to JupyterLab Notebooks.
Elyra currently includes the following functionality:
- [Visual Pipeline Editor](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#ai-pipelines-visual-editor)
- [Ability to run a notebook, Python or R script as a batch job](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#ability-to-run-a-notebook-python-or-r-script-as-a-batch-job)
- [Reusable Code Snippets](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#reusable-code-snippets)
- [Hybrid runtime support](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#hybrid-runtime-support) based on [Jupyter Enterprise Gateway](https://github.com/jupyter/enterprise_gateway)
- [Python and R script editors with local/remote execution capabilities](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#python-and-r-scripts-execution-support)
- [Python script navigation using auto-generated Table of Contents](https://elyra.readthedocs.io/en/latest/getting_started/overview.html##python-and-r-scripts-execution-support)
- [Python script integrated debugger (Experimental)](https://elyra.readthedocs.io/en/latest/getting_started/overview.html##python-and-r-scripts-execution-support)
- [Notebook navigation using auto-generated outlines using Table of Contents](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#notebook-navigation-using-auto-generated-table-of-contents)
- [Language Server Protocol integration](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#language-server-protocol-integration)
- [Version control using Git integration](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#version-control-using-git-integration)
The [Elyra Getting Started Guide](https://elyra.readthedocs.io/en/latest/getting_started/overview.html) includes more details on these features. A version-specific summary of new features is located on the [releases page](https://github.com/elyra-ai/elyra/releases).
## Try Elyra
#### Using container images
You can also try Elyra by running one of the container images from [Docker Hub](https://hub.docker.com/r/elyra/elyra/tags) or [quay.io](https://quay.io/repository/elyra/elyra?tab=tags):
- `elyra/elyra:latest` has the latest released version installed.
- `elyra/elyra:x.y.z` has a specific version installed.
Note: You can also [build a container image from the `main` branch ("dev build")](https://github.com/elyra-ai/elyra/tree/main/etc/docker/elyra) to try out features that have not been released yet.
To run one of the container images, issue the following command, specifying a tag of your choice.
```
docker run -it -p 8888:8888 elyra/elyra:3.15.0 jupyter lab --debug
```
To make a local directory containing your Notebooks (e.g. ${HOME}/opensource/jupyter-notebooks/) available in your
docker container, you can use a mount command similar to the following:
```
docker run -it -p 8888:8888 -v ${HOME}/opensource/jupyter-notebooks/:/home/jovyan/work -w /home/jovyan/work elyra/elyra:3.15.0 jupyter lab --debug
```
These should produce output similar to that below, where you can then find the URL to be used to access Elyra in your local browser.
```
To access the notebook, open this file in a browser:
file:///home/jovyan/.local/share/jupyter/runtime/nbserver-6-open.html
Or copy and paste one of these URLs:
http://4d17829ecd4c:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82
or http://127.0.0.1:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82
```
Refer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html#docker) for details.
## Installation
For detailed information refer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html).
### Prerequisites :
* [Node.js 18+](https://nodejs.org/en/)
* [Python 3.8+](https://www.python.org/downloads/)
* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) (optional)
### Install current release (for JupyterLab 3.x)
The current release version is displayed at the top of this page.
- Install from PyPI
```bash
pip3 install --upgrade "elyra[all]"
```
- Install from conda-forge
```bash
conda install -c conda-forge "elyra[all]"
```
### Install older release
Installation instructions and JupyterLab support vary by release. Note that a JupyterLab build is required. Installation instructions are located in the [release-specific documentation](https://elyra.readthedocs.io/en/stable/), which can be accessed by selecting a specific version.
<details>
<summary>Elyra 3.1 < 3.7 (JupyterLab 3.x)</summary>
- Install from PyPI
```bash
pip3 install --upgrade "elyra[all]>=3.1.0" && jupyter lab build
```
- Install from conda-forge
```bash
conda install -c conda-forge "elyra[all]>=3.1.0" && jupyter lab build
```
</details>
<details>
<summary>Elyra 2.0 < 3.1 (JupyterLab 3.x)</summary>
- Install from PyPI
```bash
pip3 install --upgrade "elyra>=2.0.1" && jupyter lab build
```
- Install from conda-forge
```bash
conda install -c conda-forge "elyra>=2.0.1" && jupyter lab build
```
</details>
### Verify Installation
Run the following commands to verify the installation. Note that in the example output below the `[version]` placeholder is displayed instead of an actual version identifier, which might change with every release.
```bash
jupyter server extension list
```
Should output:
```
Config dir: /.../.jupyter
Config dir: /.../etc/jupyter
elyra enabled
- Validating elyra...
elyra OK
jupyter_lsp enabled
- Validating jupyter_lsp...
jupyter_lsp [version] OK
jupyter_resource_usage enabled
- Validating jupyter_resource_usage...
jupyter_resource_usage [version] OK
jupyter_server_mathjax enabled
- Validating jupyter_server_mathjax...
jupyter_server_mathjax OK
jupyterlab enabled
- Validating jupyterlab...
jupyterlab [version] OK
jupyterlab_git enabled
- Validating jupyterlab_git...
jupyterlab_git [version] OK
nbclassic enabled
- Validating nbclassic...
nbclassic OK
nbdime enabled
- Validating nbdime...
nbdime [version] OK
Config dir: /.../etc/jupyter
```
NOTE: If you don't see the Elyra server extension enabled, you may need to explicitly enable
it with `jupyter server extension enable elyra`
```bash
jupyter labextension list
```
Should output:
```
JupyterLab [version]
/.../share/jupyter/labextensions
nbdime-jupyterlab [version] enabled OK
@jupyter-server/resource-usage [version] enabled OK (python, jupyter-resource-usage)
@krassowski/jupyterlab-lsp [version] enabled OK (python, jupyterlab_lsp)
@elyra/code-snippet-extension [version] enabled OK
@elyra/code-viewer-extension [version] enabled OK
@elyra/metadata-extension [version] enabled OK
@elyra/pipeline-editor-extension [version] enabled OK
@elyra/python-editor-extension [version] enabled OK
@elyra/scala-editor-extension [version] enabled OK
@elyra/r-editor-extension [version] enabled OK
@elyra/theme-extension [version] enabled OK
@jupyterlab/git [version] enabled OK (python, jupyterlab-git)
Other labextensions (built into JupyterLab)
app dir: /.../share/jupyter/lab
```
## Starting Elyra
After verifying Elyra has been installed, start Elyra with:
```bash
jupyter lab
```
## Getting Help
We welcome your questions, ideas, and feedback. Check the [`Getting Help` section in the `Getting Started guide`](https://elyra.readthedocs.io/en/latest/getting_started/getting-help.html) to learn more about the channels you can use to get in touch with us.
## Contributing to Elyra
If you are interested in helping make Elyra better, we encourage you to take a look at our
[Contributing](CONTRIBUTING.md) page,
[Development Workflow](https://elyra.readthedocs.io/en/latest/developer_guide/development-workflow.html)
documentation, and invite you to attend our weekly dev community meetings.
## Meetup with Us!
Our daily and weekly community meeting schedule can be found [here](https://github.com/elyra-ai/community#daily-dev-meetings).
Raw data
{
"_id": null,
"home_page": "",
"name": "elyra",
"maintainer": "Elyra Maintainers",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/65/7e/bf1ffaa9410ca2a4026cadbf8cffabb05235f6b064289de8bbad047dad56/elyra-3.15.0.tar.gz",
"platform": null,
"description": "<!--\n{% comment %}\nCopyright 2018-2022 Elyra Authors\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n{% endcomment %}\n-->\n\n\n[](https://badge.fury.io/py/elyra)\n[](https://anaconda.org/conda-forge/elyra)\n[](https://pepy.tech/project/elyra)\n[](https://elyra.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/elyra-ai/elyra/issues)\n[](https://bestpractices.coreinfrastructure.org/projects/5761)\n[](https://gitter.im/elyra-ai/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)\n\n# Elyra\n\nElyra is a set of AI-centric extensions to JupyterLab Notebooks.\n\nElyra currently includes the following functionality:\n\n- [Visual Pipeline Editor](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#ai-pipelines-visual-editor)\n- [Ability to run a notebook, Python or R script as a batch job](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#ability-to-run-a-notebook-python-or-r-script-as-a-batch-job)\n- [Reusable Code Snippets](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#reusable-code-snippets)\n- [Hybrid runtime support](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#hybrid-runtime-support) based on [Jupyter Enterprise Gateway](https://github.com/jupyter/enterprise_gateway)\n- [Python and R script editors with local/remote execution capabilities](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#python-and-r-scripts-execution-support)\n- [Python script navigation using auto-generated Table of Contents](https://elyra.readthedocs.io/en/latest/getting_started/overview.html##python-and-r-scripts-execution-support)\n- [Python script integrated debugger (Experimental)](https://elyra.readthedocs.io/en/latest/getting_started/overview.html##python-and-r-scripts-execution-support)\n- [Notebook navigation using auto-generated outlines using Table of Contents](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#notebook-navigation-using-auto-generated-table-of-contents)\n- [Language Server Protocol integration](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#language-server-protocol-integration)\n- [Version control using Git integration](https://elyra.readthedocs.io/en/latest/getting_started/overview.html#version-control-using-git-integration)\n\n\n\nThe [Elyra Getting Started Guide](https://elyra.readthedocs.io/en/latest/getting_started/overview.html) includes more details on these features. A version-specific summary of new features is located on the [releases page](https://github.com/elyra-ai/elyra/releases).\n\n## Try Elyra\n\n#### Using container images\n\nYou can also try Elyra by running one of the container images from [Docker Hub](https://hub.docker.com/r/elyra/elyra/tags) or [quay.io](https://quay.io/repository/elyra/elyra?tab=tags):\n- `elyra/elyra:latest` has the latest released version installed.\n- `elyra/elyra:x.y.z` has a specific version installed.\n\nNote: You can also [build a container image from the `main` branch (\"dev build\")](https://github.com/elyra-ai/elyra/tree/main/etc/docker/elyra) to try out features that have not been released yet. \n\nTo run one of the container images, issue the following command, specifying a tag of your choice.\n\n```\ndocker run -it -p 8888:8888 elyra/elyra:3.15.0 jupyter lab --debug\n```\n\nTo make a local directory containing your Notebooks (e.g. ${HOME}/opensource/jupyter-notebooks/) available in your\ndocker container, you can use a mount command similar to the following:\n\n```\ndocker run -it -p 8888:8888 -v ${HOME}/opensource/jupyter-notebooks/:/home/jovyan/work -w /home/jovyan/work elyra/elyra:3.15.0 jupyter lab --debug\n```\n\nThese should produce output similar to that below, where you can then find the URL to be used to access Elyra in your local browser.\n\n```\n To access the notebook, open this file in a browser:\n file:///home/jovyan/.local/share/jupyter/runtime/nbserver-6-open.html\n Or copy and paste one of these URLs:\n http://4d17829ecd4c:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82\n or http://127.0.0.1:8888/?token=d690bde267ec75d6f88c64a39825f8b05b919dd084451f82\n```\n\nRefer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html#docker) for details.\n\n## Installation\n\nFor detailed information refer to the [installation documentation](https://elyra.readthedocs.io/en/stable/getting_started/installation.html).\n\n### Prerequisites :\n* [Node.js 18+](https://nodejs.org/en/)\n* [Python 3.8+](https://www.python.org/downloads/)\n* [Miniconda](https://docs.conda.io/en/latest/miniconda.html) (optional)\n\n### Install current release (for JupyterLab 3.x)\n\nThe current release version is displayed at the top of this page.\n\n - Install from PyPI\n\n ```bash\n pip3 install --upgrade \"elyra[all]\"\n ```\n\n - Install from conda-forge\n\n ```bash\n conda install -c conda-forge \"elyra[all]\"\n ```\n\n### Install older release\n\nInstallation instructions and JupyterLab support vary by release. Note that a JupyterLab build is required. Installation instructions are located in the [release-specific documentation](https://elyra.readthedocs.io/en/stable/), which can be accessed by selecting a specific version. \n\n<details>\n <summary>Elyra 3.1 < 3.7 (JupyterLab 3.x)</summary>\n\n - Install from PyPI\n\n ```bash\n pip3 install --upgrade \"elyra[all]>=3.1.0\" && jupyter lab build\n ```\n\n - Install from conda-forge\n\n ```bash\n conda install -c conda-forge \"elyra[all]>=3.1.0\" && jupyter lab build\n ```\n</details>\n\n<details>\n <summary>Elyra 2.0 < 3.1 (JupyterLab 3.x)</summary>\n\n - Install from PyPI\n \n ```bash\n pip3 install --upgrade \"elyra>=2.0.1\" && jupyter lab build\n ```\n\n - Install from conda-forge\n\n ```bash\n conda install -c conda-forge \"elyra>=2.0.1\" && jupyter lab build\n ```\n</details>\n\n### Verify Installation \n\nRun the following commands to verify the installation. Note that in the example output below the `[version]` placeholder is displayed instead of an actual version identifier, which might change with every release.\n\n```bash\njupyter server extension list\n```\nShould output:\n```\nConfig dir: /.../.jupyter\n\nConfig dir: /.../etc/jupyter\n elyra enabled\n - Validating elyra...\n elyra OK\n jupyter_lsp enabled\n - Validating jupyter_lsp...\n jupyter_lsp [version] OK\n jupyter_resource_usage enabled\n - Validating jupyter_resource_usage...\n jupyter_resource_usage [version] OK\n jupyter_server_mathjax enabled\n - Validating jupyter_server_mathjax...\n jupyter_server_mathjax OK\n jupyterlab enabled\n - Validating jupyterlab...\n jupyterlab [version] OK\n jupyterlab_git enabled\n - Validating jupyterlab_git...\n jupyterlab_git [version] OK\n nbclassic enabled\n - Validating nbclassic...\n nbclassic OK\n nbdime enabled\n - Validating nbdime...\n nbdime [version] OK\n\nConfig dir: /.../etc/jupyter\n```\n\nNOTE: If you don't see the Elyra server extension enabled, you may need to explicitly enable\nit with `jupyter server extension enable elyra`\n\n```bash\njupyter labextension list\n```\nShould output:\n``` \nJupyterLab [version]\n/.../share/jupyter/labextensions\n nbdime-jupyterlab [version] enabled OK\n @jupyter-server/resource-usage [version] enabled OK (python, jupyter-resource-usage)\n @krassowski/jupyterlab-lsp [version] enabled OK (python, jupyterlab_lsp)\n @elyra/code-snippet-extension [version] enabled OK\n @elyra/code-viewer-extension [version] enabled OK\n @elyra/metadata-extension [version] enabled OK\n @elyra/pipeline-editor-extension [version] enabled OK\n @elyra/python-editor-extension [version] enabled OK\n @elyra/scala-editor-extension [version] enabled OK\n @elyra/r-editor-extension [version] enabled OK\n @elyra/theme-extension [version] enabled OK\n @jupyterlab/git [version] enabled OK (python, jupyterlab-git)\n\nOther labextensions (built into JupyterLab)\n app dir: /.../share/jupyter/lab\n```\n\n## Starting Elyra\nAfter verifying Elyra has been installed, start Elyra with:\n```bash\njupyter lab\n```\n\n## Getting Help\n\nWe welcome your questions, ideas, and feedback. Check the [`Getting Help` section in the `Getting Started guide`](https://elyra.readthedocs.io/en/latest/getting_started/getting-help.html) to learn more about the channels you can use to get in touch with us.\n\n## Contributing to Elyra\nIf you are interested in helping make Elyra better, we encourage you to take a look at our \n[Contributing](CONTRIBUTING.md) page, \n[Development Workflow](https://elyra.readthedocs.io/en/latest/developer_guide/development-workflow.html)\ndocumentation, and invite you to attend our weekly dev community meetings.\n\n## Meetup with Us!\nOur daily and weekly community meeting schedule can be found [here](https://github.com/elyra-ai/community#daily-dev-meetings).\n",
"bugtrack_url": null,
"license": "",
"summary": "Elyra provides AI Centric extensions to JupyterLab",
"version": "3.15.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbd30e9c548b560f617acb5f2adb6938ad4d624951788ef520f9f516a875f3f3",
"md5": "0ee2ba16e4a50c6c167157ae5d3cc90e",
"sha256": "0b31d0e4b04936dad3a4ed1c8718c120cbdf00a781c524fbd05444e72c304b4f"
},
"downloads": -1,
"filename": "elyra-3.15.0-py3-none-any.whl",
"has_sig": true,
"md5_digest": "0ee2ba16e4a50c6c167157ae5d3cc90e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10230762,
"upload_time": "2023-03-29T00:26:43",
"upload_time_iso_8601": "2023-03-29T00:26:43.855016Z",
"url": "https://files.pythonhosted.org/packages/fb/d3/0e9c548b560f617acb5f2adb6938ad4d624951788ef520f9f516a875f3f3/elyra-3.15.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "657ebf1ffaa9410ca2a4026cadbf8cffabb05235f6b064289de8bbad047dad56",
"md5": "996194011742e9b502475a1a806eadfc",
"sha256": "ec12a3ed329adc052aabdfb8ba092e3d27ba96aa0561b213e8b9f2ba362d7884"
},
"downloads": -1,
"filename": "elyra-3.15.0.tar.gz",
"has_sig": true,
"md5_digest": "996194011742e9b502475a1a806eadfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9762256,
"upload_time": "2023-03-29T00:26:49",
"upload_time_iso_8601": "2023-03-29T00:26:49.147096Z",
"url": "https://files.pythonhosted.org/packages/65/7e/bf1ffaa9410ca2a4026cadbf8cffabb05235f6b064289de8bbad047dad56/elyra-3.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-29 00:26:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "elyra"
}
