A Jupyter Server extension enabling kernels to publish data to predictable URLs
Перейти к файлу
Peter Williams b2d6afea64
Merge pull request #5 from pkgw/front-door-email
Update the "front door" email address and add Notebook >= 7 compat
2023-08-18 20:31:07 +00:00
.config/cranko Initial code import 2021-07-02 18:10:49 -04:00
ci Work on compatibility with Notebook >= 7 2023-08-18 14:58:08 -04:00
docs docs/conf.py: update for newer Sphinx 2023-08-18 14:58:08 -04:00
jupyter-config Add drop-in configuration files to activate the server extension 2021-10-23 13:18:13 -04:00
wwt_kernel_data_relay Work on compatibility with Notebook >= 7 2023-08-18 14:58:08 -04:00
.coveragerc Initial code import 2021-07-02 18:10:49 -04:00
.gitignore Initial code import 2021-07-02 18:10:49 -04:00
.readthedocs.yml .readthedocs.yml: update this 2023-08-18 15:02:19 -04:00
CHANGELOG.md Initial code import 2021-07-02 18:10:49 -04:00
LICENSE Initial code import 2021-07-02 18:10:49 -04:00
MANIFEST.in Add drop-in configuration files to activate the server extension 2021-10-23 13:18:13 -04:00
README.md Work on compatibility with Notebook >= 7 2023-08-18 14:58:08 -04:00
pyproject.toml Work on compatibility with Notebook >= 7 2023-08-18 14:58:08 -04:00
setup.py Work on compatibility with Notebook >= 7 2023-08-18 14:58:08 -04:00

README.md

Build Status

WWT Kernel Data Relay

wwt_kernel_data_relay is a Jupyter server extension that enables Jupyter kernels to publish some of their data files to the Web; that is, to request that the Jupyter HTTP server make them accessible at a predictable URL. This functionality is used by pywwt, the WorldWide Telescope Python library, to expose kernel-side data assets for visualization inside the WWT research app.

Installation

Install wwt_kernel_data_relay with pip:

pip install wwt_kernel_data_relay

Contributions

Contributions to wwt_kernel_data_relay are welcome! See the WorldWide Telescope contributors guide for applicable information. We use a standard workflow with issues and pull requests. All participants in wwt_kernel_data_relay and the WWT communities must abide by the WWT Code of Conduct.

Release History

Releases of wwt_kernel_data_relay are logged in the file CHANGELOG.md on the release branch of this repository, as well as release listings maintained by GitHub and PyPI.

Dependencies

wwt_kernel_data_relay is a Jupyter server extension so it is only useful if the Jupyter jupyter_server package is installed.

It also is compatible with the older (version <= 6) notebook server package.

Legalities

wwt_kernel_data_relay is copyright the .NET Foundation. It is licensed under the MIT License.

Acknowledgments

wwt_kernel_data_relay is part of the WorldWide Telescope system, a .NET Foundation project. Work on WWT has been supported by the American Astronomical Society (AAS), the US National Science Foundation, and other partners. See the WWT user website for details.