prompt-toolkit / prompt-toolkit/python-prompt-toolkit

Completer example

Open
#203 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
10.6k
Forks
815
PR merge metrics
No merged PRs in 30d

Description

It would be really nice to have a basic and well documented completer example. I hacked something together from the other apps around based on prompt toolkit, it's here: https://gist.github.com/blark/46d6befc51909c7db4e0 But this only completes a list of words.

What I'm really interested in is context dependent recommendations... changing the recommendation based on the last word typed. I could probably figure out a way to do it, but the code would be ugly -- I'd love to see a clean example. THANKS!

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the linked gist and the existing apps that use prompt_toolkit to compare their completer patterns. Add a basic, well-documented example showing context-dependent recommendations based on the last word typed; the example should be clear enough to demonstrate the intended behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.