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

Requirement in README and install instructions contradictory. #1291

Closed
Northo opened this issue Nov 7, 2023 · 4 comments
Closed

Requirement in README and install instructions contradictory. #1291

Northo opened this issue Nov 7, 2023 · 4 comments

Comments

@Northo
Copy link

Northo commented Nov 7, 2023

After #1271, there seem to be a contradiction in the README. The top parts says "JupyterLab >= 4.0" in requirements, while the installation instructions are pip install --upgrade "jupyterlab<4" jupyterlab-git.
From my experiments, it seems like 4.0 does not work.

It seems like the Requirements section of README does not agree with the installation guide anymore. While the installation guide asks for "jupyterlab<4", the Requirements say "JupyterLab >= 4.0". This sounds contradictory to me.

Originally posted by @markusReinert in #1271 (comment)

Copy link

welcome bot commented Nov 7, 2023

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.
welcome
You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋

Welcome to the Jupyter community! 🎉

@krassowski
Copy link
Member

The jupyterlab-git v0.50.0rc0 supporting JupyterLab 4.0 is in release candidate phase, and as such you will need to add --pre to the pip install command, for example:

pip install --pre "jupyterlab-git==0.50.0rc0"

(see #1245 (comment)).

As soon as the final version is released (hopefully very soon) the plain pip install will just work.

@Northo
Copy link
Author

Northo commented Nov 7, 2023

Great!

However, I still believe the docs should be updated. As it seems 0.50 will be released quite soon, maybe it is sufficient to simply remove the <4 constraint from the installation instructions in the README?

@fcollonval
Copy link
Member

Fixed by #1305

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

No branches or pull requests

3 participants