rename configs

Author: echarles

examples/simple/README.md

@@ -7,21 +7,38 @@ This folder contains example of simple extensions on top of Jupyter Server and r
 You need `python3` to build and run the server extensions.
 
 ```bash
+# Clone, create a conda env and install from source.
 git clone https://github.com/jupyter/jupyter_server && \
   cd examples/simple && \
   conda create -y -n jupyter_server_example python=3.7 && \
   conda activate jupyter_server_example && \
   pip install -e .
 ```
 
-**OPTIONAL** If you want to build the Typescript code, you need `npm` on your local env. Compiled javascript is provided as artifact in this repository, so this Typescript build step is optional. The Typescript source and configuration has been taken from https://github.com/markellekelly/jupyter-server-example.
+**OPTIONAL** If you want to build the Typescript code, you need [npm](https://www.npmjs.com) on your local environement. Compiled javascript is provided as artifact in this repository, so this Typescript build step is optional. The Typescript source and configuration have been taken from https://github.com/markellekelly/jupyter-server-example.
 
 ```bash
 npm install && \
   npm run build
 ```
 
-## Start Extension 1
+## No Extension
+
+Ensure Jupyter Server is starting without any extension enabled.
+
+```bash
+# Run this command from a shell.
+jupyter server
+```
+
+Browse the default home page, it should show a white page in your browser with the following content: `A Jupyter Server is running.`
+
+```bash
+# Jupyter Server default Home Page.
+open http://localhost:8888
+```
+
+## Extension 1
 
 ```bash
 # Start the jupyter server activating simple_ext1 extension.
@@ -31,8 +48,6 @@ jupyter server --ServerApp.jpserver_extensions="{'simple_ext1': True}"
 Now you can render `Extension 1` Server content in your browser.
 
 ```bash
-# Jupyter Server Home Page.
-open http://localhost:8888/
 # Home page as defined by default_url = '/default'.
 open http://localhost:8888/simple_ext1/default
 # HTML static page.
@@ -52,16 +67,16 @@ open http://localhost:8888/simple_ext1/redirect
 open http://localhost:8888/static/simple_ext1/favicon.ico
 ```
 
-## Start Extension 2
+## Extension 1 and Extension 2
 
-The following command starts both `simple_ext1` and `simple_ext2` extensions.
+The following command starts both the `simple_ext1` and `simple_ext2` extensions.
 
 ```bash
 # Start the jupyter server, it will load both simple_ext1 and simple_ext2 based on the provided trait.
 jupyter server --ServerApp.jpserver_extensions="{'simple_ext1': True, 'simple_ext2': True}"
 ```
 
-You can also render `Extension 2` Server content in your browser.
+Check that the previous `Extension 1` content is still available ant that you can also render `Extension 2` Server content in your browser.
 
 ```bash
 # HTML static page.
@@ -70,7 +85,7 @@ open http://localhost:8888/static/simple_ext2/test.html
 open http://localhost:8888/simple_ext2/params/test?var1=foo
 ```
 
-## Start with Entrypoints
+## Work with Entrypoints
 
 Optionally, you can copy `simple_ext1.json` and `simple_ext2.json` configuration to your env `etc` folder and start only Extension 1, which will also start Extension 2.
 
@@ -90,20 +105,20 @@ Stop any running server (with `CTRL+C`) and start with additional configuration
 The provided settings via CLI will override the configuration that reside in the files (`jupyter_simple_ext1_config.py`...)
 
 ```bash
-jupyter server \ 
-  --ServerApp.jpserver_extensions="{'simple_ext1': True, 'simple_ext2': True}" \
-  --SimpleApp1.cli=OK
+jupyter simple-ext1 --SimpleApp1.configA "ConfigA from command line"
 ```
 
-Check the log, it should return on startup something like the following base on the trait you have defined in the CLI and in the `jupyter_server_config.py`.
+Check the log, it should return on startup something like the following base on the trait you have defined in the CLI and in the `jupyter_simple_ext1_config.py`.
 
 ```
-[SimpleApp1] SimpleApp1.app OK
-[SimpleApp1] SimpleApp1.file OK
-[SimpleApp1] SimpleApp1.cli OK
+[SimpleApp1] Config {'SimpleApp1': {'configA': 'ConfigA from file', 'configB': 'ConfigB from file', 'configC': 'ConfigC from file'}}
+[SimpleApp1] Config {'SimpleApp1': {'configA': 'ConfigA from file', 'configB': 'ConfigB from file', 'configC': 'ConfigC from file'}}
+[SimpleApp2] WARNING | Config option `configD` not recognized by `SimpleApp2`.  Did you mean `config_file`?
+[SimpleApp2] Config {'SimpleApp2': {'configD': 'ConfigD from file'}}
+[SimpleApp1] Config {'SimpleApp1': {'configA': 'ConfigA from command line', 'configB': 'ConfigB from file', 'configC': 'ConfigC from file'}}
 ```
 
-## Start only Extension 2
+## Only Extension 2
 
 Now stop agin the server and start with only `Extension 2`.
 
@@ -114,43 +129,18 @@ jupyter simple-ext2
 
 Try with the above links to check that only Extension 2 is responding (Extension 1 URLs should give you an 404 error).
 
-## Extension 11 extending Extension 1
+## Extension 11 extends Extension 1
 
 `Extension 11` extends `Extension 1` and brings a few more configs.
 
 Run `jupyter simple-ext11 --generate-config && vi ~/.jupyter/jupyter_config.py`.
 
+> --generate-config returns an execption `"The ExtensionApp has not ServerApp "`
+
 The generated configuration should contains the following.
 
 ```bash
-...
-#  Can be used to override templates from notebook.templates.
-#c.ExtensionApp.template_paths = []
-
-#------------------------------------------------------------------------------
-# SimpleApp1(ExtensionApp) configuration
-#------------------------------------------------------------------------------
-
-#------------------------------------------------------------------------------
-# SimpleApp11(SimpleApp1) configuration
-#------------------------------------------------------------------------------
-
-## Say hello
-#c.SimpleApp11.hello = False
-
-## Ignore Javascript
-#c.SimpleApp11.ignore_js = False
-
-## Simple directory
-#c.SimpleApp11.simple11_dir = ''
-
-#------------------------------------------------------------------------------
-# ServerApp(JupyterApp) configuration
-#------------------------------------------------------------------------------
-
-## Set the Access-Control-Allow-Credentials: true header
-#c.ServerApp.allow_credentials = False
-...
+TBD
 ```
 
 The `hello`, `ignore_js` and `simple11_dir` are traits defined on the SimpleApp11 class.

examples/simple/jupyter_server_config.py

@@ -5,4 +5,4 @@
 #------------------------------------------------------------------------------
 
 ## The date format used by logging formatters for %(asctime)s
-c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S Simple_Extensions'
+c.Application.log_datefmt = '%Y-%m-%d %H:%M:%S Simple_Extensions_Example'

examples/simple/jupyter_simple_ext1_config.py

@@ -1,3 +1,3 @@
-c.SimpleApp1.app = 'an app'
-c.SimpleApp1.cli = 'a cli'
-c.SimpleApp1.file = 'a file'
+c.SimpleApp1.configA = 'ConfigA from file'
+c.SimpleApp1.configB = 'ConfigB from file'
+c.SimpleApp1.configC = 'ConfigC from file'

examples/simple/jupyter_simple_ext2_config.py

@@ -1 +1 @@
-c.SimpleApp2.file = 'OK'
+c.SimpleApp2.configD = 'ConfigD from file'

examples/simple/simple_ext1/application.py

@@ -28,19 +28,19 @@ class SimpleApp1(ExtensionApp):
         DEFAULT_TEMPLATE_FILES_PATH
     ]
 
-    file = Unicode('',
+    configA = Unicode('',
         config=True,
-        help='File path'
+        help='Config A example.'
     )
 
-    app = Unicode('',
+    configB = Unicode('',
         config=True,
-        help='File path'
+        help='Config B example.'
     )
 
-    cli = Unicode('',
+    configC = Unicode('',
         config=True,
-        help='File path'
+        help='Config C example.'
     )
 
     def initialize_handlers(self):
@@ -53,31 +53,8 @@ def initialize_handlers(self):
             (r'/{}/(.*)', ErrorHandler)
         ])
 
-    def initialize_templates(self):
-        jenv_opt = {"autoescape": True}
-        env = jinja2.Environment(
-            loader=jinja2.FileSystemLoader(self.template_paths),
-            extensions=["jinja2.ext.i18n"],
-            **jenv_opt
-        )
-        template_settings = {"simple_ext1_jinja2_env": env}
-        self.settings.update(**template_settings)
-
-    def get_conf(self, key):
-        c = self.settings.get('config').get(type(self).__name__)
-        if c:
-            return c.get(key, None)
-        else:
-            return None
-
     def initialize_settings(self):
         self.log.info('Config {}'.format(self.config))
-#        self.log.info('SimpleApp1.app {}'.format(self.get_conf('app')))
-#        self.log.info('SimpleApp1.file {}'.format(self.get_conf('file')))
-#        self.log.info('SimpleApp1.cli {}'.format(self.get_conf('cli')))
-#        self.log.info('Complete Settings {}'.format(self.settings))
-#        self.settings.get('config').get(self.extension_name).update({'app': 'OK'})
-#        self.settings["{}_config".format(self.extension_name)].update(**self.settings.get('config').get('SimpleApp1'))
 
 #-----------------------------------------------------------------------------
 # Main entry point

examples/simple/simple_ext1/handlers.py

@@ -2,15 +2,12 @@
 
 class DefaultHandler(ExtensionHandler):
     def get(self):
-        # The ExtensionApp’s config object.
-#        self.log.info("Settings in {} Default Handler: {}".format(self.extension_name, self.settings))
-        self.log.info("Config in {} Default Handler: {}".format(self.extension_name, self.config))
-        # self.log.info(self.server_config)
         # The name of the extension to which this handler is linked.
         self.log.info("Extension Name in {} Default Handler: {}".format(self.extension_name, self.extension_name))
         # A method for getting the url to static files (prefixed with /static/<extension_name>).
         self.log.info("Static URL for / in simple_ext1 Default Handler:".format(self.static_url(path='/')))
         self.write('<h1>Hello Simple 1 - I am the default...</h1>')
+        self.write('Config in {} Default Handler: {}'.format(self.extension_name, self.config))
 
 class RedirectHandler(ExtensionHandler):
     def get(self):
@@ -28,15 +25,15 @@ def get(self, matched_part=None, *args, **kwargs):
 class BaseTemplateHandler(ExtensionHandler):
     def get_template(self, path):
         """Return the jinja template object for a given name"""
-        return self.settings['simple_ext1_jinja2_env'].get_template(path)
+        return self.settings['{}_jinja2_env'.format(self.extension_name)].get_template(path)
 
 class TypescriptHandler(BaseTemplateHandler):
     def get(self):
         self.write(self.render_template("typescript.html"))
 
 class TemplateHandler(BaseTemplateHandler):
     def get(self, path):
-#        print(self.get_template('simple1.html'))
+        """ Optionaly, you can print(self.get_template('simple1.html'))"""
         self.write(self.render_template('simple1.html', path=path))
 
 class ErrorHandler(BaseTemplateHandler):

examples/simple/simple_ext11/application.py

@@ -55,17 +55,11 @@ def simple11_dir_formatted(self):
         return "/" + self.simple11_dir
 
     def initialize_settings(self):
-        self.log.info('SimpleApp11.hello: {}'.format(super().get_conf('hello')))
         self.log.info('hello: {}'.format(self.hello))
-        if self.get_conf('hello') == True:
+        if self.config['hello'] == True:
             self.log.info("Hello Simple11 - You have provided the --hello flag or defined 'c.SimpleApp1.hello == True' in jupyter_server_config.py")
-        self.log.info('SimpleApp11.simple11_dir: {}'.format(self.get_conf('simple11_dir')))
-        self.log.info('SimpleApp11.ignore_js: {}'.format(self.get_conf('ignore_js')))
         self.log.info('ignore_js: {}'.format(self.ignore_js))
-        c = self.settings.get('config').get(type(self).__name__)
-        if c:
-            self.settings["{}_config".format(self.extension_name)].update(**c)
-#        super().initialize_settings()
+        super().initialize_settings()
 
 #-----------------------------------------------------------------------------
 # Main entry point

examples/simple/simple_ext2/application.py

@@ -1,4 +1,5 @@
 import os, jinja2
+from traitlets import Unicode
 from jupyter_server.extension.application import ExtensionApp
 from .handlers import ParameterHandler, TemplateHandler, IndexHandler, ErrorHandler
 
@@ -26,6 +27,11 @@ class SimpleApp2(ExtensionApp):
         DEFAULT_TEMPLATE_FILES_PATH
     ]
 
+    configD = Unicode('',
+        config=True,
+        help='Config D example.'
+    )
+
     def initialize_handlers(self):
         self.handlers.extend([
             (r'/simple_ext2/params/(.+)$', ParameterHandler),
@@ -34,18 +40,8 @@ def initialize_handlers(self):
             (r'/simple_ext2/(.*)', ErrorHandler)
         ])
 
-    def initialize_templates(self):
-        jenv_opt = {"autoescape": True}
-        env = jinja2.Environment(
-            loader=jinja2.FileSystemLoader(self.template_paths),
-            extensions=["jinja2.ext.i18n"],
-            **jenv_opt
-        )
-        template_settings = {"simple_ext2_jinja2_env": env}
-        self.settings.update(**template_settings)
-
     def initialize_settings(self):
-        pass
+        self.log.info('Config {}'.format(self.config))
 
 #-----------------------------------------------------------------------------
 # Main entry point