How jupyter/jupyter_core works
Project type and purpose
• This is an open‑source Python library called “Jupyter Core.”
• It provides core common functionality (base application classes, configuration, path management, migration and troubleshooting utilities) for the wider Jupyter ecosystem.
• It exposes a CLI entrypoint (jupyter) and a set of reusable modules that other Jupyter subprojects import and extend.
File structure
• Top‑level files:
• jupyter.py – the main CLI entrypoint;
• pyproject.toml – build and packaging configuration;
• .github/ and workflow YAMLs – CI/CD and release automation;
• docs/ – Sphinx documentation;
• examples/ – shell wrappers and completion scripts;
• scripts/ – thin wrappers invoking the CLI;
• tests/ – unit tests for each module.
• Core package jupyter_core/ contains:
• application.py – base JupyterApp class and CLI bootstrap;
• command.py – command‐line dispatch and subcommands;
• migrate.py – profile/config migration logic;
• paths.py – resolution of Jupyter directories;
• troubleshoot.py – diagnostics collector;
• utils/ – shared helper functions;
• version.py – package version management.
README for additional insights
• Confirms that Jupyter Core “doesn’t do much on its own” but underpins all other Jupyter projects.
• Emphasizes editable installs, testing with pytest, Sphinx docs, and pre‑commit formatting.
• Clear, concise labels for each component (e.g., “CLI Entry,” “Application Bootstrap,” “Path Resolver”).
• Layering: CLI layer at top, library core in middle, external integrations at bottom.