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

The installation command pip install jupyter-ai[all] fails in a zsh environment #1209

Closed
michaele4321 opened this issue Jan 20, 2025 · 1 comment · Fixed by #1211
Closed
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@michaele4321
Copy link

Description

This is a documentation bugfix/request.

The installation step pip install jupyter-ai[all] fails in a zsh environment because zsh uses square brackets for pattern matching

The square brackets need to be escaped or the entire package name quoted.

pip install 'jupyter-ai[all]' works correctly.

Note that zsh is the default shell for Mac users since Catalina https://support.apple.com/en-ca/102360

Reproduce

  1. Follow the standard jupyter-ai installation instructions in a zsh environment (the default Mac environment)

Expected behavior

Following the installation instructions should work on Macs running the default shell.
The installation instructions could be updated to a quoted version or separate installation steps for Mac users could be added.

Context

  • Operating System and version: Mac Catalina or later
  • Browser and version: n/a
  • JupyterLab version: n/a
Troubleshoot Output
n/a
Command Line Output
n/a
Browser Output
n/a
@michaele4321 michaele4321 added the bug Something isn't working label Jan 20, 2025
@dlqqq dlqqq added the documentation Improvements or additions to documentation label Jan 21, 2025
srdas added a commit to srdas/jupyter-ai that referenced this issue Jan 21, 2025
Fixes jupyterlab#1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.
@dlqqq
Copy link
Member

dlqqq commented Jan 21, 2025

Thanks for reporting this gap in our documentation! We've already opened a PR to update the docs, and this issue will be closed shortly.

@dlqqq dlqqq closed this as completed in a0ab1b6 Jan 21, 2025
srdas added a commit to srdas/jupyter-ai that referenced this issue Jan 27, 2025
Fixes jupyterlab#1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.
srdas added a commit that referenced this issue Jan 28, 2025
* Updated documentation for pip install in zsh

Fixes #1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.

* Update openrouter.py
Darshan808 pushed a commit to Darshan808/jupyter-ai that referenced this issue Feb 4, 2025
* Updated documentation for pip install in zsh

Fixes jupyterlab#1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update index.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Darshan808 pushed a commit to Darshan808/jupyter-ai that referenced this issue Feb 4, 2025
)

* Updated documentation for pip install in zsh

Fixes jupyterlab#1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.

* Update openrouter.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants