Notebook: Document comms

Created on 2 Nov 2016  路  7Comments  路  Source: jupyter/notebook

Answering a SO question, I realised that we don't appear to have any docs on how to use comms.

Documentation

Most helpful comment

Closing as we now have some docs - that doesn't stop us improving them more!

All 7 comments

It is pretty open ended.

It is! I'd be happy to close it once we have

  • [x] some explanation of what comms are
  • [x] how to register targets in Python, connect them from JS, and send messages both ways.
  • [x] link to the messaging spec docs about comm messages for authors of other kernels.

Hey @takluyver, Thinking this was the SO question: http://stackoverflow.com/questions/40352628/messaging-and-jupyter-notebooks

If you or others want to do a detailed outline, that would be a helpful start. Alternatively links to the above 3 points in the code or other docs. Thanks.

I'm _very_ happy to pair on this or even explore it from a protocol level (see https://github.com/jupyter/jupyter_client/issues/198) during the dev meetings. I'm not a good one to speak to for the JS APIs on jupyter/notebook for comms as we're taking a slightly different approach in nteract: https://github.com/nteract/nteract/pull/840

I'm going to try to make some basic docs now. If you want to take it further, that would be great.

@takluyver If you make bullets, I'm happy to wordsmith. We can certainly iterate 馃憤

Closing as we now have some docs - that doesn't stop us improving them more!

Was this page helpful?
0 / 5 - 0 ratings