{"id":13468615,"url":"https://github.com/joouha/euporie","last_synced_at":"2025-05-13T21:06:53.729Z","repository":{"id":45721218,"uuid":"365614581","full_name":"joouha/euporie","owner":"joouha","description":"Jupyter notebooks in the terminal","archived":false,"fork":false,"pushed_at":"2025-05-12T09:17:33.000Z","size":3616,"stargazers_count":2010,"open_issues_count":13,"forks_count":49,"subscribers_count":11,"default_branch":"dev","last_synced_at":"2025-05-12T09:59:28.967Z","etag":null,"topics":["euporie","ipynb","ipython","ipython-notebook","jupyter","jupyter-notebook","kitty","prompt-toolkit","python","sixel","terminal","terminal-graphics","tui","vim"],"latest_commit_sha":null,"homepage":"https://euporie.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joouha.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-05-08T21:29:27.000Z","updated_at":"2025-05-12T09:17:36.000Z","dependencies_parsed_at":"2023-10-14T16:32:56.211Z","dependency_job_id":"8d68ad64-4422-462f-a3cc-21048d5fd6c8","html_url":"https://github.com/joouha/euporie","commit_stats":{"total_commits":1408,"total_committers":9,"mean_commits":"156.44444444444446","dds":0.125,"last_synced_commit":"5d7d4735ec2a6a92c2efbcf273223ef22512a002"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joouha%2Feuporie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joouha%2Feuporie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joouha%2Feuporie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joouha%2Feuporie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joouha","download_url":"https://codeload.github.com/joouha/euporie/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253717586,"owners_count":21952514,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["euporie","ipynb","ipython","ipython-notebook","jupyter","jupyter-notebook","kitty","prompt-toolkit","python","sixel","terminal","terminal-graphics","tui","vim"],"created_at":"2024-07-31T15:01:14.943Z","updated_at":"2025-05-13T21:06:48.717Z","avatar_url":"https://github.com/joouha.png","language":"Python","funding_links":[],"categories":["Python","\u003ca name=\"programming\"\u003e\u003c/a\u003eProgramming","Fancy shell sessions","Table of Contents"],"sub_categories":[],"readme":"|logo|\n\n.. |logo| image:: https://user-images.githubusercontent.com/12154190/160670889-c6fc4cd8-413d-49f0-b105-9c0e03117032.svg\n   :alt: \u003cLogo\u003e\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 \u003chttps://euporie.readthedocs.io/en/latest/apps/console.html\u003e`_\n     - `Notebook \u003chttps://euporie.readthedocs.io/en/latest/apps/notebook.html\u003e`_\n     - `Preview \u003chttps://euporie.readthedocs.io/en/latest/apps/preview.html\u003e`_\n     - `Hub \u003chttps://euporie.readthedocs.io/en/latest/apps/hub.html\u003e`_\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 \u003chttps://euporie.readthedocs.io/en/latest/pages/gallery.html\u003e`_\n\n----\n\n*******\nInstall\n*******\n\nYou can install euporie with `uv \u003chttps://docs.astral.sh/uv/\u003e`_  (recommended), or with `pipx \u003chttps://pipxproject.github.io/\u003e`_ 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 \u003chttps://mybinder.org/v2/gh/joouha/euporie-binder/HEAD?urlpath=%2Feuporie%2F\u003e`_.\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, \u0026 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/ \u003chttps://euporie.readthedocs.io/\u003e`_\n\nThe code is available on GitHub at: `https://github.com/joouha/euporie \u003chttps://github.com/joouha/euporie\u003e`_\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: ⭐\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoouha%2Feuporie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoouha%2Feuporie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoouha%2Feuporie/lists"}