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

Shell completion #97

Open
darrenburns opened this issue Jan 25, 2020 · 5 comments · May be fixed by #171
Open

Shell completion #97

darrenburns opened this issue Jan 25, 2020 · 5 comments · May be fixed by #171

Comments

@darrenburns
Copy link
Owner

@darrenburns darrenburns commented Jan 25, 2020

Integrate: https://github.com/click-contrib/click-completion

@Formartha
Copy link

@Formartha Formartha commented Jan 29, 2020

Do you want to integrate it? what is the use case?

@darrenburns
Copy link
Owner Author

@darrenburns darrenburns commented Jan 29, 2020

I would like to see it implemented as I think it's a nice productivity feature. In shells such as fish and zsh, if you install the completion script you will be able to tab through available options and see the help text as you type.

@Formartha
Copy link

@Formartha Formartha commented Jan 29, 2020

Okay, I can try to implement it - I just need some initial guidance to start :) are there any channels other than Github to speak with each other?

@darrenburns
Copy link
Owner Author

@darrenburns darrenburns commented Jan 29, 2020

Sure, I've created a gitter room that we can use. Please use the code-help room here: https://gitter.im/python-ward/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link

@darrenburns
Copy link
Owner Author

@darrenburns darrenburns commented Jan 29, 2020

Some initial guidance would be to take a look at the click-completion documentation, and you can find the click CLI specific stuff in Ward in run.py. For local development, you can get up and running using flit install -s (you'll need to have flit installed), which will install Ward such that you can edit and and won't need to constantly reinstall it. You can run the tests by just typing ward.

Also, take a look at the contributing guide: https://github.com/darrenburns/ward/blob/master/.github/CONTRIBUTING.md

@hoefling hoefling linked a pull request that will close this issue Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.