atiro / ipyiiif

IIIF Widget for Jupyter notebooks

jupyter-widget-iiif

A IIIF Image API viewer widget for Jupyter

Usage

from ipyiiif import Image

image = Image(url='https://images.britishart.yale.edu/iiif/f49cd573-275a-4d00-9cd8-7c150c88c259/info.json')

image

Installation

To install use pip:

$ pip install iiif
$ jupyter nbextension enable --py --sys-prefix iiif

For a development installation (requires npm),

$ git clone https://github.com/vanda/jupyter-widget-iiif.git
$ cd jupyter-widget-iiif
$ pip install -e .
$ jupyter nbextension install --py --symlink --sys-prefix iiif
$ jupyter nbextension enable --py --sys-prefix iiif

Roadmap

• Load Open Seadragon UI correctly
• Allow for options to be passed to Seadragon (zoom level, location, etc)
• Enable Drag'n'Drop of image into notebook if possible
• Support Presentation API manifests using CanvasPanel

Much longer term is to consider how to building on top of notebooks, so users do not have to enter python commands to enable functionality.

ipyiiif's Issues

ipyosd....?

I see an npm package to integrate jupyte rnotebooks with openseadragon.

https://www.npmjs.com/package/ipyosd

It references atiro/ipyosd ... this seems like this repo is an older version of that... does the ipyosd repo exist anywhere ? IS it just private?

can't install/enable nbextension

this happens during installation, no matter if directly with pip or as development- via npm:

Traceback (most recent call last):
  File "/usr/local/bin/jupyter-nbextension", line 8, in <module>
    sys.exit(main())
  File "$HOME.local/lib/python3.8/site-packages/jupyter_core/application.py", line 264, in launch_instance
    return super(JupyterApp, cls).launch_instance(argv=argv, **kwargs)
  File "$HOME.local/lib/python3.8/site-packages/traitlets/config/application.py", line 664, in launch_instance
    app.start()
  File "/usr/local/lib/python3.8/dist-packages/notebook/nbextensions.py", line 983, in start
    super(NBExtensionApp, self).start()
  File "$HOME.local/lib/python3.8/site-packages/jupyter_core/application.py", line 253, in start
    self.subapp.start()
  File "/usr/local/lib/python3.8/dist-packages/notebook/nbextensions.py", line 711, in start
    self.install_extensions()
  File "/usr/local/lib/python3.8/dist-packages/notebook/nbextensions.py", line 682, in install_extensions
    full_dests = install(self.extra_args[0],
  File "/usr/local/lib/python3.8/dist-packages/notebook/nbextensions.py", line 206, in install_nbextension_python
    m, nbexts = _get_nbextension_metadata(module)
  File "/usr/local/lib/python3.8/dist-packages/notebook/nbextensions.py", line 1119, in _get_nbextension_metadata
    raise KeyError('The Python module {} is not a valid nbextension, '
KeyError: 'The Python module iiif is not a valid nbextension, it is missing the `_jupyter_nbextension_paths()` method.'

is this package supposed to be working with the current python and pip versions?