Metadata-Version: 2.1
Name: euporie
Version: 2.0.1
Summary: Euporie is a suite of terminal applications for interacting with Jupyter kernels
Home-page: https://github.com/joouha/euporie
License: MIT
Keywords: jupyter,ipython,markdown,terminal,notebook
Author: Josiah Outram Halstead
Author-email: josiah@halstead.email
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Jupyter
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Provides-Extra: all
Provides-Extra: formatters
Provides-Extra: html-mtable
Provides-Extra: hub
Provides-Extra: images-img2unicode
Provides-Extra: latex-sympy
Provides-Extra: svg-cairosvg
Requires-Dist: CairoSVG (>=2.5,<3.0); extra == "all" or extra == "svg-cairosvg"
Requires-Dist: Pillow (>=9.0,<10.0)
Requires-Dist: Pygments (>=2.11.2,<3.0.0)
Requires-Dist: aenum (>=3.1,<4.0)
Requires-Dist: antlr4-python3-runtime (>=4.9,<5.0); extra == "latex-sympy"
Requires-Dist: appdirs (>=1.4,<2.0)
Requires-Dist: asyncssh (>=2.10.1,<3.0.0); extra == "all" or extra == "hub"
Requires-Dist: black (>=19.3b0); extra == "all" or extra == "formatters"
Requires-Dist: fastjsonschema (>=2.15.3,<3.0.0)
Requires-Dist: flatlatex (>=0.15,<0.16)
Requires-Dist: html5lib (>=1.1,<2.0); extra == "html-mtable"
Requires-Dist: imagesize (>=1.3.0,<2.0.0)
Requires-Dist: img2unicode (>=0.1a8,<0.2); extra == "images-img2unicode"
Requires-Dist: isort (>=5.10.1,<6.0.0); extra == "all" or extra == "formatters"
Requires-Dist: jupyter-client (>=7.1,<8.0)
Requires-Dist: linkify (>=1.4,<2.0)
Requires-Dist: markdown-it-py[linkify] (>=2.0.1,<3.0.0)
Requires-Dist: mdit-py-plugins (>=0.3.0,<0.4.0)
Requires-Dist: mtable (>=0.1,<0.2); extra == "html-mtable"
Requires-Dist: nbformat (>=5,<6)
Requires-Dist: prompt-toolkit (>=3.0.27,<4.0.0)
Requires-Dist: pyperclip (>=1.8,<2.0)
Requires-Dist: ssort (>=0.11.6,<0.12.0); extra == "all" or extra == "formatters"
Requires-Dist: sympy (>=1.9,<2.0); extra == "latex-sympy"
Requires-Dist: timg (>=1.1,<2.0)
Requires-Dist: typing-extensions (>=4.2.0,<5.0.0)
Requires-Dist: universal-pathlib (>=0.0.19,<0.0.20)
Project-URL: Bug Tracker, https://github.com/joouha/euporie/issues
Project-URL: Changelog, https://euporie.readthedocs.io/en/latest/pages/changelog.html
Project-URL: Documentation, https://euporie.readthedocs.io/en/latest
Description-Content-Type: text/x-rst

|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.

.. 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>`_

.. figure:: https://user-images.githubusercontent.com/12154190/182201621-9c3e4b04-1b1e-46e3-b852-b43f16adfc7b.png
   :target: https://user-images.githubusercontent.com/12154190/182201621-9c3e4b04-1b1e-46e3-b852-b43f16adfc7b.png

   `View more screenshots here <https://euporie.readthedocs.io/en/latest/pages/gallery.html>`_

----

*******
Install
*******

You can install euporie with `pipx <https://pipxproject.github.io/>`_ (recommended) or ``pip``:

.. code-block:: console

   $ 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
* Vim / Emacs / Micro style key-bindings
* Run code interactively in a console
* Convert a console session to a notebook
* Use Jupyter widgets interactively in the terminal
* Display images using terminal graphics (sixel / iterm / kitty)
* Render rich kernel output (markdown, tables, images, LaTeX, HTML, SVG, & PDF)
* Tab-completion, line suggestions  and contextual help
* 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: ⭐

