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

chore(readme): Enclose URL in Quotes #36

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Jannchie
Copy link
Contributor

@Jannchie Jannchie commented Dec 24, 2023

Thanks for this amazing work!


$ pip install git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]

zsh: no matches found: git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]

I am trying to install this package from a Git repository using pip with zsh. The error message zsh: no matches found typically occurs in the Z shell (zsh) when it tries to interpret special characters. In the command, the square brackets ([]) are likely causing the issue, as zsh treats them as a pattern-matching character.

To fix this, we can either escape the square brackets or enclose the entire URL in quotes.
This change does not affect bash users and is compatible with zsh users.

Related stackoverflow link: https://stackoverflow.com/a/30539963/8625892

@cumulo-autumn
Copy link
Owner

Thank you for pointing out that problem and suggesting enclosing the entire URL in quotes which accommodates both environments.

However, since quotes are not commonly used in regular pip installations, I am a bit concerned that it might actually confuse people who don't usually use zsh. I am thinking about what to do with the README. Perhaps, it would be a good idea to add a separate note suggesting to try using quotes if the installation doesn't go smoothly. This is quite a subjective matter, so it's a bit difficult to decide. I'll think about it a bit more before making a decision. Anyway, thank you very much for your feedback and the suggestion for improvement!

Copy link

@Coinbitstarhydro Coinbitstarhydro left a comment

Choose a reason for hiding this comment

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

@@ -117,14 +117,14 @@ StreamDiffusionをインストール

```bash
#最新バージョン (推奨)
pip install git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]
pip install "git+https://github.com/cumulo-autumn/StreamDiffusion.git@main#egg=streamdiffusion[tensorrt]"


Choose a reason for hiding this comment

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

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