emacs-jupyter/jupyter

Make usage of zmq module optional when using REST interface

Open

#176 opened on Aug 30, 2019

View on GitHubContributor guide
 (13 comments) (2 reactions) (0 assignees)Emacs Lisp (106 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (1,028 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I saw in the README that emacs-jupyter can now communicate with Jupyter using its REST API. Instructions are provided on Reddit.

Unfortunately, it looks like the usage of modules (which were required for 0mq communications) is still enforced, making it impossible to use the package on, e.g., a standard Debian installation of Emacs.

Since modules will likely not be enabled by most of the distros, this seems like a big impediment to adoption. Is it feasible to make modules optional?

Contributor guide

Research direction
Investigate how the zmq module is loaded and required. Find the code paths that use the REST interface and see if there is a way to conditionally require the zmq module only when the non REST interface is used. Consider adding a configuration option to enable/disable the zmq module.
Tech stack
None
Domain
apideveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Emacs LispJupyter
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70