-
Notifications
You must be signed in to change notification settings - Fork 11
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
Update HttpInlet error with correct pip install command #5
Conversation
- The error currently asks the user to 'pip install databay[HttpInlet]' this won't work for installing a package with optional depedencies. - This tiny PR adds quotation marks that are needed to correctly install aiohttp.
Welcome @cdpierse ! Thank you for the first contribution to Databay🎉!! Just before we go ahead with merging, would you mind if I ask you for the source of your contribution? I've looked into this, and I'm a bit over the fence. There are some sources which suggest that including the double quotes like you suggest is necessary - for instance this SO answer (although it suggest single quotes which don't always work). However, I also found some arguments against it:
Now, using the method you propose also works - I'm just curious as to whether there's a good reason to suggest it as the default.
Totally happy to merge this in if not using the double quotes is an inferior method or breaks on your end - just trying to understand what is the case! Thanks for baring with me on this 😊 And once again thanks for participating and for the kind words! Really happy to hear you like this project 😅 |
Hey @Voyz, Of course no problem, I probably should have gone into more detail. I originally tested this with Python 3.7.7 and noticed I was getting - I think this SO post has what I've seen to be best guess at what's going on. In the comments section on the question part of the post one of the users mentions that the brackets are to be used as a protection against accidental shell expansion of the install pattern. So my guess with this is that it has to be with my choice of "zsh" as my default shell and I'm probably running into the exact issue mentioned by that user. What shell are you using on you machine btw ? My guess would be that it's not zsh. I think including some sort of quotes is probably the safest thing to do here to make sure that everyone can install correctly off that command. What do you think ? |
That's a fantastic explanation - you are absolutely right @cdpierse. I'm not using Zsh and so in my shell that was not a problem. Frankly, it's the first time I encounter shell expansion, so I'm glad you brought it to my attention. In a way I am surprised the documentation I quoted earlier doesn't advise to use double quotes, seeing how this could be a common problem for multiple users. Naturally in such case your contribution is the right way to go, thank you for proposing it! Could I bother you to introduce that same change to Once again, thank you for catching this issue and creating this first PR, great job! 😊 |
No problem at all. I've just added those additional changes now. It does seem surprising that the documentation isn't more explicit on what the best practice should be. Thanks again on a great package, I'm looking forward to seeing how this develops and hopefully contributing more in the future 😄 |
That's great, thank you for adding these in! You also correctly caught that MongoOutlet has a small instruction on top which should also be updated. That made me realise we should also update HttpInlet that has an analogous instruction there too. I went ahead and committed that small change to your branch directly so that I could merge this in right way. Also, I noticed you added Going ahead with a merge. Congrats on completing the first contributing PR for Databay! 😄 Please accept the happy dancing penguin as a reward: Looking forward to more collaboration in the future! Any questions send them over and let me know how your experience goes. Take care! |
this won't work for installing a package with optional depedencies.
aiohttp.
Also great job on this project. I'm really enjoying what you've done so far!