strawberry-graphql / strawberry

A GraphQL library for Python that leverages type annotations 🍓
https://strawberry.rocks
MIT License
4.02k stars 533 forks source link

Add quotes around Pip extra installs in `README`/docs to support ZSH shells #1326

Closed ajhynes7 closed 3 years ago

ajhynes7 commented 3 years ago

Hello, I wanted to try out this package but I can't install the extra dependency debug-server.

pip install strawberry-graphql is successful, but pip install strawberry-graphql[debug-server] is not.

❯ pip install strawberry-graphql[debug-server]
zsh: no matches found: strawberry-graphql[debug-server]

Environment

Upvote & Fund

Fund with Polar

12306hujunjie commented 3 years ago

you can fix it with '' pip install 'strawberry-graphql[debug-server]'

ajhynes7 commented 3 years ago

That worked, thanks!

ajhynes7 commented 3 years ago

The docs don't have the quotes though, so it's a bit confusing. Do you know why the quotes are needed?

jkimbo commented 3 years ago

@ajhynes7 it's a zsh thing: https://zsh.sourceforge.io/Doc/Release/Expansion.html#Glob-Operators

patrick91 commented 3 years ago

@jkimbo shall we add quotes to the docs? Zsh is the default on mac and maybe some linux distros too :)

jkimbo commented 3 years ago

@patrick91 yep we probably should

jkimbo commented 3 years ago

Fixed in #1356

BryceBeagle commented 3 years ago

I'm not sure this is entirely resolved in #1356 because that just updated the README. We still have the docs (on the website) to update

memark commented 3 years ago

@BryceBeagle Well spotted, I'll update them in a separate PR.

There are some example pip installs in CHANGELOG, should I update?

There are some example pip installs in cli/commands/server.py, should I update?

BryceBeagle commented 3 years ago

I wouldn't worry about updating the CHANGELOG

BryceBeagle commented 3 years ago

I'd update the help text in cli/commands/server.py, though

jkimbo commented 3 years ago

I think we've successfully resolved this now.

ajhynes7 commented 3 years ago

Ok thank you!