jupyter-server / extension-cookiecutter Goto Github PK

Problem

Current jupyter server documentation doesn't have any references for using a config/trait in the extension app. This forces extension writers to use alternate means to configure their applications by using env variables or other custom configuration methods.

Proposed Solution

Add a trait/config to the extension app that showcases use of config to set properties with default values but configurable from the extension config. Also add code to show use of this trait within a handler.

Additional context

Description

I ran through the setup process with cookiecutter to generate my sample extension but I'm not understanding how to test it within a running jupyter server. My (naive) understanding was that this extension just adds a /ping endpoint to the server that responds with a 200 and 'pong', but I'm either misunderstanding the code, or missing something.

The server extension does appear to load correctly judging from the logs below

Reproduce

1. run cookiecutter https://github.com/jupyter-server/extension-cookiecutter
2. complete prompts and navigate into the new directory
3. run pip install .
4. run jupyter server

Expected behavior

I expected to be able to curl http://localhost:8888/myextension/ping but that returned a 404 instead of "pong"

Context

• Operating System and version:
• Browser and version:
• Jupyter Server version:

Paste the output from running `jupyter troubleshoot` from the command line here.
You may want to sanitize the paths in the output.

Paste the output from your command line running `jupyter lab` here, use `--debug` if possible.

Paste the output from your browser Javascript console here, if applicable.

Currently we are using a top level url (/ping) in the recipe. It should be namespaced with the extension name, to promote best practices.

Problem

Maybe we can add some unit test templates

Just like https://github.com/jupyter-server/jupyter_server/tree/main/examples/simple/tests

And pytest config like

https://github.com/jupyter-server/jupyter_server/blob/main/examples/simple/pytest.ini

https://github.com/jupyter-server/jupyter_server/blob/main/examples/simple/conftest.py

Proposed Solution

Additional context

We should use jupyter_server.pytest_plugin and create a simple test file.

For an example see,

https://github.com/jupyter-server/jupyter_server/blob/main/examples/simple/conftest.py
https://github.com/jupyter-server/jupyter_server/blob/main/examples/simple/tests/test_handlers.py

We would need to add a test dependency on jupyter_server[test] in pyproject.toml, e.g.

[project.optional-dependencies]
tests = [
  'pytest',
  'jupyter_server[test]`
]