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

Incorrect Install Command in README #86

Closed
jlargs64 opened this issue Oct 4, 2024 · 4 comments · Fixed by #87
Closed

Incorrect Install Command in README #86

jlargs64 opened this issue Oct 4, 2024 · 4 comments · Fixed by #87

Comments

@jlargs64
Copy link
Contributor

jlargs64 commented Oct 4, 2024

In the [installation section] (https://github.com/localstack/awscli-local?tab=readme-ov-file#installation) of the main README.md, the commands are incorrect. Instead of pip install awscli-local[ver1] it should be pip install "awscli-local[ver1]". Otherwise, you get the following error:

pip install awscli-local[ver1]
no matches found: awscli-local[ver1]
@alexrashed
Copy link
Member

Actually they are correct if you are not using zsh 😛
Here's a StackExchange thread on the topic: https://apple.stackexchange.com/questions/427572/zsh-conflict-with-python-setuptools-extras-and-pip
Here's the respective part of the zsh docs: https://zsh.sourceforge.io/Doc/Release/Expansion.html#Filename-Generation

However, zsh is the default on on MacOS, so it would make sense to have a compatible command in the readme. Would you be interested in creating a PR? Otherwise I can quickly take this one as well :)

@jlargs64
Copy link
Contributor Author

jlargs64 commented Oct 7, 2024

Ha good catch! I am using Mac and zsh - I never knew that was a specific issue. I'd happily update the README for this :)

@alexrashed
Copy link
Member

Great! Do you need any help with this? :)

@jlargs64
Copy link
Contributor Author

jlargs64 commented Oct 9, 2024

@alexrashed I think I should be good! I just got busy at work the past few days. I'm making the PR now :)

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 a pull request may close this issue.

2 participants