| Name | euporie JSON |
| Version |
2.8.6
JSON |
| download |
| home_page | None |
| Summary | Euporie is a suite of terminal applications for interacting with Jupyter kernels |
| upload_time | 2025-01-29 10:02:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
euporie
ipython
jupyter
markdown
notebook
terminal
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|logo|
.. |logo| image:: https://user-images.githubusercontent.com/12154190/160670889-c6fc4cd8-413d-49f0-b105-9c0e03117032.svg
:alt: <Logo>
#######
euporie
#######
|PyPI| |RTD| |PyVer| |License| |Binder| |Stars|
.. content_start
**Euporie is a terminal based interactive computing environment for Jupyter.**
Euporie's apps allow you to interact with Jupyter kernels, and run Jupyter notebooks - entirely from the terminal.
If you're working with Jupyter notebooks in a terminal only environment, like an SSH server or a container, or just prefer working in the terminal, then euporie is the tool for you!
.. list-table::
:align: center
:widths: 25 25 25 25
:class: text-center
* - `Console <https://euporie.readthedocs.io/en/latest/apps/console.html>`_
- `Notebook <https://euporie.readthedocs.io/en/latest/apps/notebook.html>`_
- `Preview <https://euporie.readthedocs.io/en/latest/apps/preview.html>`_
- `Hub <https://euporie.readthedocs.io/en/latest/apps/hub.html>`_
.. image:: https://github.com/joouha/euporie/assets/12154190/c8ea6e23-11bb-4ffc-a9e5-111f788c51ae
:target: https://github.com/joouha/euporie/assets/12154190/c8ea6e23-11bb-4ffc-a9e5-111f788c51ae
`View more screenshots here <https://euporie.readthedocs.io/en/latest/pages/gallery.html>`_
----
*******
Install
*******
You can install euporie with `uv <https://docs.astral.sh/uv/>`_ (recommended), or with `pipx <https://pipxproject.github.io/>`_ or ``pip``):
.. code-block:: console
$ uv tool install euporie
$ # OR
$ pipx install euporie
$ # OR
$ python -m pip install --user euporie
You can also try euporie online `here <https://mybinder.org/v2/gh/joouha/euporie-binder/HEAD?urlpath=%2Feuporie%2F>`_.
********
Features
********
* Edit and run notebooks in the terminal
* Run code interactively in a console
* Display images using terminal graphics (sixel / iterm / kitty)
* Use Jupyter widgets interactively in the terminal
* Render rich kernel output (markdown, tables, images, LaTeX, HTML, SVG, & PDF)
* Tab-completion, line suggestions and contextual help
* Convert a console session to a notebook
* Micro / Vim / Emacs style key-bindings
*****
Usage
*****
**Notebooks**
You can edit a notebook using ``euporie-notebook``, and passing the notebook's file path or URI as a command line argument:
.. code-block:: console
$ euporie-notebook notebook.ipynb
Alternatively, launch ``euporie-notebooks`` and open a notebook file by selecting "Open" from the file menu (``Ctrl+O``).
**Console**
To connect to a Jupyter kernel and run code interactively in a console session, you can run
.. code-block:: console
$ euporie-console
(You can press ``Ctrl+C`` to open the command palette in ``euporie-console``).
**Preview**
To preview a notebook to the terminal, use the ``euporie-preview`` subcommand:
.. code-block:: console
$ euporie-preview notebook.ipynb
**Hub**
To run euporie hub, a multi-user SSH server for euporie apps, run:
.. code-block:: console
$ euporie-hub --port 8022 --host-keys=ssh_host_ed25519_key --client-keys=authorized_keys
where ``ssh_host_ed25519_key`` is the path to your host key file, and ``authorized_keys`` is a file containing SSH public keys allowed to connect.
*************
Documentation
*************
View the online documentation at: `https://euporie.readthedocs.io/ <https://euporie.readthedocs.io/>`_
The code is available on GitHub at: `https://github.com/joouha/euporie <https://github.com/joouha/euporie>`_
*************
Compatibility
*************
Euporie requires Python 3.8 or later. It works on Linux, Windows and MacOS
.. |PyPI| image:: https://img.shields.io/pypi/v/euporie.svg
:target: https://pypi.python.org/project/euporie/
:alt: Latest Version
.. |RTD| image:: https://readthedocs.org/projects/euporie/badge/
:target: https://euporie.readthedocs.io/en/latest/
:alt: Documentation
.. |PyVer| image:: https://img.shields.io/pypi/pyversions/euporie
:target: https://pypi.python.org/project/euporie/
:alt: Supported Python versions
.. |Binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/joouha/euporie-binder/HEAD?urlpath=%2Feuporie%2F
:alt: Launch with Binder
.. |License| image:: https://img.shields.io/github/license/joouha/euporie.svg
:target: https://github.com/joouha/euporie/blob/main/LICENSE
:alt: View license
.. |Stars| image:: https://img.shields.io/github/stars/joouha/euporie
:target: https://github.com/joouha/euporie/stargazers
:alt: ⭐
Raw data
{
"_id": null,
"home_page": null,
"name": "euporie",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "euporie, ipython, jupyter, markdown, notebook, terminal",
"author": null,
"author_email": "Josiah Outram Halstead <josiah@halstead.email>",
"download_url": "https://files.pythonhosted.org/packages/39/00/24457430a6655518da2af77a58eddfd8d06efd93182a4b560c947aa0da81/euporie-2.8.6.tar.gz",
"platform": null,
"description": "|logo|\n\n.. |logo| image:: https://user-images.githubusercontent.com/12154190/160670889-c6fc4cd8-413d-49f0-b105-9c0e03117032.svg\n :alt: <Logo>\n\n#######\neuporie\n#######\n\n|PyPI| |RTD| |PyVer| |License| |Binder| |Stars|\n\n.. content_start\n\n**Euporie is a terminal based interactive computing environment for Jupyter.**\n\nEuporie's apps allow you to interact with Jupyter kernels, and run Jupyter notebooks - entirely from the terminal.\n\nIf you're working with Jupyter notebooks in a terminal only environment, like an SSH server or a container, or just prefer working in the terminal, then euporie is the tool for you!\n\n.. list-table::\n :align: center\n :widths: 25 25 25 25\n :class: text-center\n\n * - `Console <https://euporie.readthedocs.io/en/latest/apps/console.html>`_\n - `Notebook <https://euporie.readthedocs.io/en/latest/apps/notebook.html>`_\n - `Preview <https://euporie.readthedocs.io/en/latest/apps/preview.html>`_\n - `Hub <https://euporie.readthedocs.io/en/latest/apps/hub.html>`_\n\n.. image:: https://github.com/joouha/euporie/assets/12154190/c8ea6e23-11bb-4ffc-a9e5-111f788c51ae\n :target: https://github.com/joouha/euporie/assets/12154190/c8ea6e23-11bb-4ffc-a9e5-111f788c51ae\n\n`View more screenshots here <https://euporie.readthedocs.io/en/latest/pages/gallery.html>`_\n\n----\n\n*******\nInstall\n*******\n\nYou can install euporie with `uv <https://docs.astral.sh/uv/>`_ (recommended), or with `pipx <https://pipxproject.github.io/>`_ or ``pip``):\n\n.. code-block:: console\n\n $ uv tool install euporie\n $ # OR\n $ pipx install euporie\n $ # OR\n $ python -m pip install --user euporie\n\nYou can also try euporie online `here <https://mybinder.org/v2/gh/joouha/euporie-binder/HEAD?urlpath=%2Feuporie%2F>`_.\n\n********\nFeatures\n********\n\n* Edit and run notebooks in the terminal\n* Run code interactively in a console\n* Display images using terminal graphics (sixel / iterm / kitty)\n* Use Jupyter widgets interactively in the terminal\n* Render rich kernel output (markdown, tables, images, LaTeX, HTML, SVG, & PDF)\n* Tab-completion, line suggestions and contextual help\n* Convert a console session to a notebook\n* Micro / Vim / Emacs style key-bindings\n\n*****\nUsage\n*****\n\n**Notebooks**\n\n You can edit a notebook using ``euporie-notebook``, and passing the notebook's file path or URI as a command line argument:\n\n .. code-block:: console\n\n $ euporie-notebook notebook.ipynb\n\n Alternatively, launch ``euporie-notebooks`` and open a notebook file by selecting \"Open\" from the file menu (``Ctrl+O``).\n\n**Console**\n\n To connect to a Jupyter kernel and run code interactively in a console session, you can run\n\n .. code-block:: console\n\n $ euporie-console\n\n (You can press ``Ctrl+C`` to open the command palette in ``euporie-console``).\n\n**Preview**\n\n To preview a notebook to the terminal, use the ``euporie-preview`` subcommand:\n\n .. code-block:: console\n\n $ euporie-preview notebook.ipynb\n\n**Hub**\n\n To run euporie hub, a multi-user SSH server for euporie apps, run:\n\n .. code-block:: console\n\n $ euporie-hub --port 8022 --host-keys=ssh_host_ed25519_key --client-keys=authorized_keys\n\n where ``ssh_host_ed25519_key`` is the path to your host key file, and ``authorized_keys`` is a file containing SSH public keys allowed to connect.\n\n*************\nDocumentation\n*************\n\nView the online documentation at: `https://euporie.readthedocs.io/ <https://euporie.readthedocs.io/>`_\n\nThe code is available on GitHub at: `https://github.com/joouha/euporie <https://github.com/joouha/euporie>`_\n\n*************\nCompatibility\n*************\n\nEuporie requires Python 3.8 or later. It works on Linux, Windows and MacOS\n\n\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/euporie.svg\n :target: https://pypi.python.org/project/euporie/\n :alt: Latest Version\n\n.. |RTD| image:: https://readthedocs.org/projects/euporie/badge/\n :target: https://euporie.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. |PyVer| image:: https://img.shields.io/pypi/pyversions/euporie\n :target: https://pypi.python.org/project/euporie/\n :alt: Supported Python versions\n\n.. |Binder| image:: https://mybinder.org/badge_logo.svg\n :target: https://mybinder.org/v2/gh/joouha/euporie-binder/HEAD?urlpath=%2Feuporie%2F\n :alt: Launch with Binder\n\n.. |License| image:: https://img.shields.io/github/license/joouha/euporie.svg\n :target: https://github.com/joouha/euporie/blob/main/LICENSE\n :alt: View license\n\n.. |Stars| image:: https://img.shields.io/github/stars/joouha/euporie\n :target: https://github.com/joouha/euporie/stargazers\n :alt: \u2b50\n",
"bugtrack_url": null,
"license": null,
"summary": "Euporie is a suite of terminal applications for interacting with Jupyter kernels",
"version": "2.8.6",
"project_urls": {
"Changelog": "https://euporie.readthedocs.io/en/latest/pages/changelog.html",
"Documentation": "https://euporie.readthedocs.io/en/latest",
"Issues": "https://github.com/joouha/euporie/issues",
"Source": "https://github.com/joouha/euporie"
},
"split_keywords": [
"euporie",
" ipython",
" jupyter",
" markdown",
" notebook",
" terminal"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a1456d44260007ec9fdb806d519f89df435c81764bb1ee5fd11aadd3bd70cb5a",
"md5": "2430f7df5592476007aa928f33aca86a",
"sha256": "2187c2b1ee4e8b21ade887619727eef904ddbd6aceac478ac046218dd24e0be4"
},
"downloads": -1,
"filename": "euporie-2.8.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2430f7df5592476007aa928f33aca86a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 466969,
"upload_time": "2025-01-29T10:02:49",
"upload_time_iso_8601": "2025-01-29T10:02:49.117709Z",
"url": "https://files.pythonhosted.org/packages/a1/45/6d44260007ec9fdb806d519f89df435c81764bb1ee5fd11aadd3bd70cb5a/euporie-2.8.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "390024457430a6655518da2af77a58eddfd8d06efd93182a4b560c947aa0da81",
"md5": "d504a945fa3f5f1245952a0d6bd643b9",
"sha256": "347c587bd477454c50d842a8379593a10a26beb2e65477f2ee4efd62b1038e96"
},
"downloads": -1,
"filename": "euporie-2.8.6.tar.gz",
"has_sig": false,
"md5_digest": "d504a945fa3f5f1245952a0d6bd643b9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 391521,
"upload_time": "2025-01-29T10:02:45",
"upload_time_iso_8601": "2025-01-29T10:02:45.668765Z",
"url": "https://files.pythonhosted.org/packages/39/00/24457430a6655518da2af77a58eddfd8d06efd93182a4b560c947aa0da81/euporie-2.8.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 10:02:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joouha",
"github_project": "euporie",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "euporie"
}
