jupyter_server_hello_world_extension_quickstart.py

1import os
2from jupyter_server.extension.application import ExtensionApp
3from jupyter_server.serverapp import ServerApp
4
5class HelloWorldExtension(ExtensionApp):
6    # The name of the extension.
7    name = "hello_world"
8
9    def initialize_handlers(self):
10        # This is where you would add your own handlers to the web application.
11        # For a simple quickstart, we'll just print a message.
12        self.log.info("Hello World Extension Initialized!")
13
14if __name__ == "__main__":
15    # To run this example:
16    # 1. Instantiate the ServerApp
17    # 2. Load the extension
18    # 3. Launch the server
19    
20    app = ServerApp.instance()
21    
22    # Load our extension class into the ServerApp
23    # In a real scenario, this is often handled via config or entry points
24    app.jpserver_extensions = {
25        HelloWorldExtension.name: True
26    }
27    
28    # Initialize and start the server
29    app.initialize()
30    app.start()