Skip to content

config: load Jupyter application-specific config files - #784

Open
oliver-sanders wants to merge 1 commit into
cylc:masterfrom
oliver-sanders:jupyter-application-specific-config-files
Open

config: load Jupyter application-specific config files#784
oliver-sanders wants to merge 1 commit into
cylc:masterfrom
oliver-sanders:jupyter-application-specific-config-files

Conversation

@oliver-sanders

@oliver-sanders oliver-sanders commented Jan 27, 2026

Copy link
Copy Markdown
Member
  • Load jupyterhub_config.py files for JupyterHub.
  • Load jupyter_cylc_config.py files for Jupyter Server.

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
  • Tests are included (or explain why tests are not needed).
  • Changelog entry included if this is a change that can affect users
  • Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
  • If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

@oliver-sanders oliver-sanders added this to the 1.9.0 milestone Jan 27, 2026
@oliver-sanders oliver-sanders self-assigned this Jan 27, 2026
@oliver-sanders
oliver-sanders force-pushed the jupyter-application-specific-config-files branch from b2f2f2f to 2cc2a6c Compare January 27, 2026 10:23
@oliver-sanders
oliver-sanders requested a review from wxtim January 27, 2026 10:27
Comment thread changes.d/784.feat.md Outdated

@wxtim wxtim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏼

@oliver-sanders

Copy link
Copy Markdown
Member Author

I can't see evidence of jupyter_server.py files being loaded.

Sounds like grounds to reject?

@wxtim

wxtim commented Jan 29, 2026

Copy link
Copy Markdown
Member

I can't see evidence of jupyter_server.py files being loaded.

Sounds like grounds to reject?

Refresh page? I followed up explaining my daft mistake.

@oliver-sanders

oliver-sanders commented Feb 19, 2026

Copy link
Copy Markdown
Member Author

Refresh page? I followed up explaining my daft mistake.

No, I agree with your comment, that file ain't loaded!

It's looking for jupyter_cylc_config.py (because we're loading it through the extension it uses the extension name, not the jupyter application name)

* Load `jupyterhub_config.py` files for JupyterHub.
* Load `jupyter_cylc_config.py` files for Cylc UI Server.
@oliver-sanders
oliver-sanders force-pushed the jupyter-application-specific-config-files branch from 2cc2a6c to b162b70 Compare February 19, 2026 16:55
@oliver-sanders
oliver-sanders requested a review from wxtim February 19, 2026 16:55
@oliver-sanders

Copy link
Copy Markdown
Member Author

@wxtim, corrected the filename and added some documentation.

Please could you double check this makes sense and the filepaths are correct (print statements in the files is a reasonable acid test).

@oliver-sanders
oliver-sanders requested review from samuel-denton and removed request for samuel-denton and wxtim March 30, 2026 16:24
Comment thread README.md

2) Site Config

This file configures the Hub/UIS for all users. The default path can be

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This file configures the Hub/UIS for all users. The default path can be
These files configure the Hub/UIS for all users. The default path can be

Comment thread README.md

3) User Config

This file

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This file
These files configure the Hub/UIs locally per user, overwriting global config.

I don't know if that's correct but I think it needs something there.

@samuel-denton

Copy link
Copy Markdown
Contributor

It working fine for me, the correct config is loaded for the HUB vs GUI:
image
image

Other than wording updates to the README I think it's good to go.

Only thing that threw me slightly was that both new configs are located in .cylc/uiserver when there is already a directory for .cylc/hub and what appears to be it's own config (jupyter_config.py). A print statement in there is not picked up so I guess that is for something different. As long as it's documented it's fine to me.

@oliver-sanders

Copy link
Copy Markdown
Member Author

there is already a directory for .cylc/hub

I don't think Cylc auto-creates this directory or file. It's not documented because it doesn't do anything to the best of my knowledge.

@samuel-denton

Copy link
Copy Markdown
Contributor

We might want to add something for 'jupyter_cylc_config.py' to the README.
Does this also need a matching PR for cylc-doc for both new configs?

@samuel-denton

Copy link
Copy Markdown
Contributor

there is already a directory for .cylc/hub

I don't think Cylc auto-creates this directory or file. It's not documented because it doesn't do anything to the best of my knowledge.

Ok, not sure how I've ended up with one but thats fine if it's not used.

@oliver-sanders oliver-sanders modified the milestones: 1.9.0, 1.10.0 May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants