prompt-toolkit / prompt-toolkit/python-prompt-toolkit
Allow showing options of a command before typed
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10.6k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
I opened this issue: https://github.com/click-contrib/click-repl/issues/11 for a separate project (click-repl) that uses python-prompt-toolkit. Here's my issue there:
My motivation for using `click-repl` is to make my script more discovereable for users. So it'll be nice if, when they're starting to type a command, the options for that command would show on the screen so they could choose from them, even without typing `-`.
As you can see from @untitaker 's response, he doesn't know how to make python-prompt-toolkit provide that.
Can python-prompt-toolkit provide that? Is this a feature request?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked click-repl issue and the existing python-prompt-toolkit completion behavior. Determine whether showing a command's options before the user types an option is supported, and define the expected interactive behavior and completion criteria before identifying the relevant entry point.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100