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

[Bug]: Show example pip install instructions with quotes for mac users #947

Closed
2 tasks done
rly opened this issue Jul 10, 2024 · 3 comments · Fixed by #956
Closed
2 tasks done

[Bug]: Show example pip install instructions with quotes for mac users #947

rly opened this issue Jul 10, 2024 · 3 comments · Fixed by #956
Labels

Comments

@rly
Copy link
Contributor

rly commented Jul 10, 2024

What happened?

I just worked with a user who had previously run pip install neuroconv[openephys] on a Mac, got the error zsh: no matches found: neuroconv[openephys], and gave up, thinking it just doesn't work on their system or neuroconv is broken.

I believe pip install "neuroconv[openephys]" with double quotes should work fine on all common shells. MacOS uses zsh (as of Catalina, released in 2019) which requires quotes around square brackets. Bash works fine with no quotes or quotes. I think Windows Powershell requires quotes. Single quotes do not work on Windows cmd. So I suggest using double quotes in all pip install instructions.

related: mu-editor/mu#852 and https://discuss.python.org/t/pep-621-how-to-specify-dependencies/4599/61

Steps to Reproduce

pip install neuroconv[openephys] on a Mac

Traceback

No response

Operating System

macOS

Python Executable

Conda

Python Version

3.11

Package Versions

No response

Code of Conduct

@rly rly added the bug label Jul 10, 2024
@CodyCBakerPhD
Copy link
Member

This has always been included as a note on step 1 of the user guide: https://neuroconv.readthedocs.io/en/main/user_guide/datainterfaces.html#installation

Could consider just adding quotes to all galleries

@bendichter
Copy link
Contributor

Yes, I think adding quotes to all the gallery pages is a good idea

@rly
Copy link
Contributor Author

rly commented Jul 12, 2024

Thanks for the quick fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants