Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add jupyter lite contents flag instructions #212

Conversation

mcbarton
Copy link
Collaborator

Description

Please include a summary of changes, motivation and context for this PR.

This PR adds to the documentation the instructions the installing of jupyter_server so that users can add contents to their own deployments. I add an example to add the Jupyter Lite xeus-cpp demo notebook currently deployed for xeus-cpp.

Fixes # (issue)

Type of change

Please tick all options which are relevant.

  • Bug fix
  • New feature
  • Added/removed dependencies
  • Required documentation updates

@mcbarton mcbarton requested a review from anutosh491 January 11, 2025 10:05
@codecov-commenter
Copy link

codecov-commenter commented Jan 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.72%. Comparing base (ddeb5ca) to head (e2c2161).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #212   +/-   ##
=======================================
  Coverage   80.72%   80.72%           
=======================================
  Files          19       19           
  Lines         970      970           
  Branches       93       93           
=======================================
  Hits          783      783           
  Misses        187      187           

@mcbarton
Copy link
Collaborator Author

@anutosh491 can you review this PR?

README.md Outdated
@@ -101,8 +101,8 @@ To build Jupyter Lite with this kernel without creating a website you can execut
```bash
micromamba create -n xeus-lite-host jupyterlite-core
micromamba activate xeus-lite-host
python -m pip install jupyterlite-xeus
jupyter lite build --XeusAddon.prefix=$PREFIX
python -m pip install jupyterlite-xeus jupyter_server
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why add jupyter_server here ? Does it solve a warning or something ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ahh actually I got it. This is due to jupyterlite/jupyterlite#1402

Copy link
Collaborator

Choose a reason for hiding this comment

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

Wait a better way to get jupyter_server is through micromamba

use
micromamba create -n xeus-lite-host jupyterlite-core jupyter-server and then let's move this in

@anutosh491
Copy link
Collaborator

Left some reviews. Thanks this was needed. once addressed I can move this in !

@anutosh491
Copy link
Collaborator

anutosh491 commented Jan 16, 2025

Actually I don't think we really need to add contents as a part of building xeus-cpp-lite. Just complicates the process for anyone interested to try out a simple build. We just need to add it as a per of our deployment so that if anyone tries our custom link they know what to do. I'll do this as a part of #221

see the last commit where I have done what is recommended
i) getting jupyterlite-xeus through a pip install
ii) other stuff from micromamba

@anutosh491
Copy link
Collaborator

Closing in favour of #221

@anutosh491 anutosh491 closed this Jan 16, 2025
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