Skip to content

Conversation

@a5chin
Copy link
Owner

@a5chin a5chin commented Oct 28, 2025

PR Type

Enhancement, Documentation


Description

  • Integrate Jupyter into the development environment.

  • Update README.md with Jupyter demo and workflow changes.

  • Configure VS Code for notebook formatting on save.

  • Refactor format and lint commands to use Nox.


Diagram Walkthrough

flowchart LR
  A["Jupyter Integration"] --> B["Dev Environment Setup"];
  B --> C["VS Code Extensions"];
  B --> D["pyproject.toml Dependencies"];
  B --> E["VS Code Notebook Settings"];
  F["Workflow Improvement"] --> G["README.md Updates"];
  F --> H["Nox for Formatting/Linting"];
  C -- "includes" --> A;
  D -- "supports" --> A;
  E -- "enhances" --> A;
  G -- "documents" --> F;
  H -- "implements" --> F;
Loading

File Walkthrough

Relevant files
Configuration changes
devcontainer.json
Add Jupyter extension to Dev Container                                     

.devcontainer/devcontainer.json

  • Added the ms-toolsai.jupyter extension to the dev container
    configuration.
+1/-0     
extensions.json
Recommend Jupyter extension for VS Code                                   

.vscode/extensions.json

  • Added ms-toolsai.jupyter to the list of recommended VS Code
    extensions.
+1/-0     
settings.json
Enable notebook formatting on save in VS Code                       

.vscode/settings.json

  • Enabled notebook code actions on save for fixAll and organizeImports.
  • Enabled automatic notebook formatting on save.
+5/-0     
Documentation
README.md
Update README for Jupyter, Nox, and workflow changes         

README.md

  • Updated the demo image to include a Jupyter demonstration.
  • Marked the jupyter and rye branches as archived.
  • Updated GitHub Actions descriptions to reflect format.yml and lint.yml
    workflows.
  • Replaced direct uv run ruff commands with uv run nox for formatting
    and linting.
  • Updated the project structure diagram to include .coveragerc,
    noxfile.py, and renovate.json.
+11/-8   
Dependencies
pyproject.toml
Add Jupyter and ipykernel development dependencies             

pyproject.toml

  • Added ipykernel and jupyter to the dev dependency group.
+2/-0     

@a5chin a5chin self-assigned this Oct 28, 2025
@github-actions
Copy link
Contributor

Coverage

Coverage Report
FileStmtsMissCover
tools/config
   fastapi.py20100%
   settings.py200100%
tools/logger
   color.py120100%
   googlecloud.py60100%
   local.py120100%
   logger.py230100%
   style.py70100%
   type.py50100%
tools/tracer
   timer.py160100%
TOTAL1030100%

Tests Skipped Failures Errors Time
8 0 💤 0 ❌ 0 🔥 1.098s ⏱️

@github-actions
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Nox Workflow

The README.md updates introduce Nox for formatting and linting commands. Ensure that the noxfile.py (which is implied by these changes) is correctly configured to execute Ruff and Pyright as intended, and that the new commands uv run nox -s fmt and uv run nox -s lint -- --pyright --ruff function correctly.

uv run nox -s fmt

# Python Linter
uv run nox -s lint -- --pyright --ruff
Notebook Formatting

The new VS Code settings for notebook.codeActionsOnSave and notebook.formatOnSave.enabled should be validated to ensure they work as expected with Jupyter notebooks and do not conflict with other formatters or linters configured in the environment.

"notebook.codeActionsOnSave": {
    "notebook.source.fixAll": "explicit",
    "notebook.source.organizeImports": "explicit"
},
"notebook.formatOnSave.enabled": true,
Branch Status

The README.md marks the jupyter branch as (Archived) while this PR is integrating Jupyter. Clarify if this refers to a previous, now obsolete, jupyter branch, or if the feature/jupyter branch will be archived immediately after this merge.

- [jupyter](https://github.com/a5chin/python-uv/tree/jupyter)(Archived)

@a5chin
Copy link
Owner Author

a5chin commented Oct 31, 2025

/improve

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

@a5chin a5chin merged commit f5e68dc into main Oct 31, 2025
8 checks passed
@a5chin a5chin deleted the feature/jupyter branch October 31, 2025 04:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants