theitsprojects / itsprompt Goto Github PK

Feature description
Currently the whole project is documented in the README, which might get too cluttered if we add even more features. A separate documentation could be more easy to use.

Feature description
Select and checkbox support big options list, and finding the one you need is hard. So with a search box, this would be easier.

Additional Information
Maybe add an optional key binding for opening a search box, and for every character hide the options that do not match the search.

Feature description
PyInquirer supports adding Seperators in some list types. These are small labels which are not selectable, but give more context to the user.

Additional Information
The prompts to include those labels are:

• checkbox
• expand
• select
• raw_select

Feature description
A TablePrompt should allow the user to input values into a table.

Feature description
With a file_path prompt, the user may write a file path and it will be autocompleted based on the files on their device.

Additional Information
This should include an autocompleter, like the one prompt_toolkit gives us.

Feature description
It should be possible for a validation to just work with lambdas which return true or false. In that case, the message will just be "Check failed".

Feature description
It would be great to have more default styling options to choose from.

Another great feature is an option to change the design of some message components, e.g. the checkboxes, the numbers and the selection arrows.

Feature description
The autocompleter should be able to give the user a few options to select from.

Additional Information
This may either be done through prompt_tookit or through a separate function.

Feature description
Currently, formatting and type checking are not enforced when pushing code.

Additional Information
Maybe add a GitHub action to do that.

Fix description
Currently, some of the images show outdated features, e.g. missing disabled options. This should be fixed.

Feature description
It should be possible to add a validation function to the TablePrompt, in order to check whether the values filled in are all correct.

Additional Information
The function should take a pandas.DataFrame and return an error message, just like the InputPrompt.

Feature description
It should be possible to disable options in a selection prompt.

Fix description
Some users think this image is a bit too cluttered and its hard to know what it describes. It should be made more clearer.

Feature description
The project currently does not have any tests. They should be added.

Feature description
Currently, TablePrompt converts all input values to strings, but a way to support other types would be preferred.

Additional Information
Since we cannot know what type the user tries to input, there should be a way to tell TablePrompt the type a specific cell should be.

Fix description
Currently, we have media which is very old. It should be updated.

The documentation links in the README also have to be updated.

Describe the bug
This script from example.py works with v1.4 but fails in v1.5 (build df965c6)

import ItsPrompt
from ItsPrompt.prompt import Prompt 

# standard input with simple lambda validation
ans = Prompt.input(
    'Please type your id',
    validate=lambda x: "test" in x,
)
print(ans)

To Reproduce
Steps to reproduce the behavior:

1. At prompt:
2. [?] 'Please type your id',
3. See error: Typing and pressing has no effect, the script is locked.

Expected behavior
Input should be able to be completed when pressing .

Device:

• Windows 10 AMD64 (build 10.0.19045) SP0
• Python 3.12.2, ItsPrompt version 1.5

Feature description
TablePrompt is currently able to use dict, where the keys are the column names. But since ItsPrompt is a tool which should be as easy to use as possible, the implementation of a list support would be great.

Additional Information
If a list is given to TablePrompt, the column names should start from "0" and go up, like pandas.DataFrame does when there are no column names given.

Feature description
A feature where after a given time the prompt automatically timeouts.

Feature description
As the user has the option to select multiple checkbox items, there should be a way to validate them.

Fix description
Currently, we only show the selected key and not its text. We need to expand to see the options description. The description should rather be shown directly after the key in brackets.

Feature description
Currently, TablePrompt is very basic. Features like marking a cell as immutable are missing.

Additional Information
It should be possible to create cells either by inputing a string (which will be the cell content) or a dictionary (may be an object as well) which has the attributes:

• content
• immutable
• type

If only a string is used, it will be assumed as not immutable and the type will be string.

An example:

{"colum 1": [{"content": "this stays as is", "immutable": True}, "type here"]}

Feature description
Some users pointed out that making TablePrompt dependant on pandas will force them to install this huge library even in smaller projects.

Additional Information
It may be possible to create a version of TablePrompt which uses dictionaries instead of DataFrames.

Feature description
ItsPrompt tries to be a project which is easy to use. A way to make it even easier would be by implementing a backwards compatibility with PyInquirer, as this project is no longer updated since a few years and does not work on the latest python versions.

Additional Information
Read more about the way this should be implemented here:

https://github.com/CITGuru/PyInquirer