Erys

Erys: Terminal Interface for Jupyter Notebooks

Erys is an innovative tool designed for efficiently opening, creating, editing, running, and interacting with Jupyter Notebooks right from the terminal. This project leverages the Textual framework for its user interface and utilizes jupyter_client for seamless code execution with various kernel managers and clients.

Features

• Open Existing Notebooks: Erys supports various formats of notebook versions and saves notebooks using format version 4.5.

• Create Notebooks: Create, edit, and save Jupyter Notebooks effortlessly.

• Code Execution: Execute Python source code within code cells. Erys requires ipykernel installed in your Python environment for code cell execution, ensuring a clean management of kernels.

• Terminal Rendering Capabilities: Supports rendering for Markdown, JSON, and error messages, enhancing the terminal experience.

  • Markdown is rendered with a Markdown widget, while JSON uses a Pretty widget.
  • Execute and visualize image/png and text/html outputs with external rendering support.

• Syntax Highlighting: Features robust syntax highlighting for Python and Markdown, utilizing Textual. Additionally, syntax highlighting through tree-sitter is available for various programming languages, making it easy to work with files of different types:

  Extension	Language
  .py	Python
  .md	Markdown
  .yaml	Yaml
  .sh	Bash
  .css	Css
  .go	Go
  .html	Html
  .java	Java
  .js	Javascript
  .json	Json
  .rs	Rust
  .toml	Toml
  .xml	Xml

Cell Functionalities

Erys provides a variety of features for managing Markdown and Code cells, including:

• Splitting and Merging: Easily split a cell at the cursor's position or merge multiple cells together.
• Collapsing: Collapse cell types and outputs to save space in the notebook.
• Moving and Copying: Move cells up and down or duplicate them within the notebook.

Key Bindings

Erys offers comprehensive key bindings for improved usability. Key bindings are context-sensitive, based on the current focus, allowing users to navigate and utilize features easily.

• App Key Bindings: Quickly manage notebooks and toggle features with keyboard shortcuts.
• Notebook Key Bindings: Streamline the notebook editing experience with intuitive commands.

Future Developments

Upcoming features aim to enhance the functionality of Erys, including execution time tracking for code cells, theme customization options, and support for additional output types.

Contribution

Contributors are welcome! Feedback and pull requests are encouraged to enhance and develop this tool further.