apeworx / ape-notebook Goto Github PK

Overview

Give the user the ability to install all 3rd party packages and Ape plugins, then run ape notebook and it takes them directly to a Jupyter Notebook with an Ape Kernel instead of a Python3 Kernel

Specification

The person installs all 3rd party packages, and installs all plugins they want to use. Then runs the command ape notebook --network:to:use to create a kernel from the individual's virtual environment and with the network they want to use

Dependencies

None

Environment information

• ape and plugin versions:

$ ape --version
0.6.17

$ ape plugins list
Installed Plugins:
  alchemy      0.6.2
  solidity     0.6.8
  etherscan    0.6.9
  notebook     0.6.0a1
  foundry      0.6.14
  risk         0.1.0a4

• Python Version: Python 3.9.6
• OS: macOS

What went wrong?

Running ape notebook fails with

$ ape notebook
WARNING: Unable to load CLI endpoint for plugin 'ape_notebook'
        ModuleNotFoundError: No module named 'notebook.notebookapp'
        (Use `--verbosity DEBUG` to see full stack-trace)
Usage: ape [OPTIONS] COMMAND [ARGS]...
Try 'ape -h' for help.

Error: No such command 'notebook'.

as ape-notebook will use the latest version of notebook for the depenendency

$ pip list
notebook                   7.0.2

given setup.py doesn't restrict to < 7.

install_requires=[
   "notebook>=6.5.2",
   ...
]

How can it be fixed?

Quick fix would be in setup.py

install_requires=[
   "notebook>=6.5.2,<7",
   ...
]

or updating plugin to use Jupyter notebook>=7,<8.

Overview

We currently only have Python3's kernel when we start a new Jupyter Notebook.
We want to be able to override this Kernel with multiple options (ethereum:mainnet network, etc) and have the ape console availabe

Specification

I believe I have to use ipykernel to do this, but there is more research that has to be done here