InquirerPrompt 0.3.0__py3-none-any.whl

InquirerPy/utils.py

@@ -0,0 +1,291 @@
+"""Module contains shared utility functions and typing aliases."""
+
+import math
+import os
+import shutil
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Callable,
+    Dict,
+    List,
+    NamedTuple,
+    Optional,
+    Tuple,
+    Union,
+)
+
+from prompt_toolkit import print_formatted_text
+from prompt_toolkit.application import run_in_terminal
+from prompt_toolkit.application.current import get_app
+from prompt_toolkit.formatted_text import FormattedText
+from prompt_toolkit.styles import Style
+from prompt_toolkit.validation import Validator
+
+from InquirerPy.exceptions import InvalidArgument
+
+if TYPE_CHECKING:
+    from prompt_toolkit.filters.base import FilterOrBool
+
+    from InquirerPy.base.control import Choice
+
+__all__ = [
+    "get_style",
+    "calculate_height",
+    "InquirerPyStyle",
+    "patched_print",
+    "color_print",
+]
+
+
+class InquirerPyStyle(NamedTuple):
+    """`InquirerPy` Style class.
+
+    Used as a helper class to enforce the method `get_style` to be used
+    while also avoiding :class:`dict` to be passed into prompts.
+
+    Note:
+        The class is an instance of :class:`typing.NamedTuple`.
+
+    Warning:
+        You should not directly be using this class besides for type hinting
+        purposes. Obtain an instance of this class using :func:`.get_style`.
+    """
+
+    dict: Dict[str, str]
+
+
+InquirerPySessionResult = Dict[Union[str, int], Optional[Union[str, bool, List[Any]]]]
+InquirerPyChoice = Union[List[Any], List["Choice"], List[Dict[str, Any]]]
+InquirerPyListChoices = Union[
+    Callable[["InquirerPySessionResult"], InquirerPyChoice],
+    InquirerPyChoice,
+]
+InquirerPyValidate = Union[Callable[[Any], bool], "Validator"]
+InquirerPyQuestions = Union[List[Dict[str, Any]], Dict[str, Any]]
+InquirerPyMessage = Union[str, Callable[["InquirerPySessionResult"], str]]
+InquirerPyDefault = Union[Any, Callable[["InquirerPySessionResult"], Any]]
+InquirerPyKeybindings = Dict[
+    str, List[Dict[str, Union[str, "FilterOrBool", List[str]]]]
+]
+
+
+def get_style(
+    style: Optional[Dict[str, str]] = None, style_override: bool = True
+) -> InquirerPyStyle:
+    """Obtain an :class:`.InquirerPyStyle` instance which can be consumed by the `style` parameter in prompts.
+
+    Tip:
+        This function supports ENV variables.
+
+        For all the color ENV variable names, refer to the :ref:`ENV <pages/env:Style>` documentation.
+
+    Note:
+        If no style is provided, then a default theme based on `one dark <https://github.com/joshdick/onedark.vim#color-reference>`_
+        color palette is applied.
+
+    Note:
+        Priority: style parameter -> ENV variable -> default style
+
+    Args:
+        style: The dictionary of style classes and their colors, If nothing is passed, the style will be resolved to the :ref:`pages/style:Default Style`.
+        style_override: A boolean to determine if the supplied `style` parameter should be merged with the :ref:`pages/style:Default Style` or override them.
+            By default, the supplied style will overwrite the :ref:`pages/style:Default Style`.
+
+    Returns:
+        An instance of :class:`.InquirerPyStyle`.
+
+    Examples:
+        >>> from InquirerPy import get_style
+        >>> from InquirerPy import inquirer
+        >>> style = get_style({"questionmark": "#ffffff", "answer": "#000000"}, style_override=False)
+        >>> result = inquirer.confirm(message="Confirm?", style=style).execute()
+    """
+    if not style_override or style is None:
+        if not style:
+            style = {}
+        result = {
+            "questionmark": os.getenv("INQUIRERPY_STYLE_QUESTIONMARK", "#e5c07b"),
+            "answermark": os.getenv("INQUIRERPY_STYLE_ANSWERMARK", "#e5c07b"),
+            "answer": os.getenv("INQUIRERPY_STYLE_ANSWER", "#61afef"),
+            "input": os.getenv("INQUIRERPY_STYLE_INPUT", "#98c379"),
+            "question": os.getenv("INQUIRERPY_STYLE_QUESTION", ""),
+            "answered_question": os.getenv("INQUIRERPY_STYLE_ANSWERED_QUESTION", ""),
+            "instruction": os.getenv("INQUIRERPY_STYLE_INSTRUCTION", "#abb2bf"),
+            "long_instruction": os.getenv(
+                "INQUIRERPY_STYLE_LONG_INSTRUCTION", "#abb2bf"
+            ),
+            "pointer": os.getenv("INQUIRERPY_STYLE_POINTER", "#61afef"),
+            "checkbox": os.getenv("INQUIRERPY_STYLE_CHECKBOX", "#98c379"),
+            "separator": os.getenv("INQUIRERPY_STYLE_SEPARATOR", ""),
+            "skipped": os.getenv("INQUIRERPY_STYLE_SKIPPED", "#5c6370"),
+            "validator": os.getenv("INQUIRERPY_STYLE_VALIDATOR", ""),
+            "marker": os.getenv("INQUIRERPY_STYLE_MARKER", "#e5c07b"),
+            "fuzzy_prompt": os.getenv("INQUIRERPY_STYLE_FUZZY_PROMPT", "#c678dd"),
+            "fuzzy_info": os.getenv("INQUIRERPY_STYLE_FUZZY_INFO", "#abb2bf"),
+            "fuzzy_border": os.getenv("INQUIRERPY_STYLE_FUZZY_BORDER", "#4b5263"),
+            "fuzzy_match": os.getenv("INQUIRERPY_STYLE_FUZZY_MATCH", "#c678dd"),
+            "spinner_pattern": os.getenv("INQUIRERPY_STYLE_SPINNER_PATTERN", "#e5c07b"),
+            "spinner_text": os.getenv("INQUIRERPY_STYLE_SPINNER_TEXT", ""),
+            **style,
+        }
+    else:
+        result = {
+            "questionmark": os.getenv("INQUIRERPY_STYLE_QUESTIONMARK", ""),
+            "answermark": os.getenv("INQUIRERPY_STYLE_ANSWERMARK", ""),
+            "answer": os.getenv("INQUIRERPY_STYLE_ANSWER", ""),
+            "input": os.getenv("INQUIRERPY_STYLE_INPUT", ""),
+            "question": os.getenv("INQUIRERPY_STYLE_QUESTION", ""),
+            "answered_question": os.getenv("INQUIRERPY_STYLE_ANSWERED_QUESTION", ""),
+            "instruction": os.getenv("INQUIRERPY_STYLE_INSTRUCTION", ""),
+            "long_instruction": os.getenv("INQUIRERPY_STYLE_LONG_INSTRUCTION", ""),
+            "pointer": os.getenv("INQUIRERPY_STYLE_POINTER", ""),
+            "checkbox": os.getenv("INQUIRERPY_STYLE_CHECKBOX", ""),
+            "separator": os.getenv("INQUIRERPY_STYLE_SEPARATOR", ""),
+            "skipped": os.getenv("INQUIRERPY_STYLE_SKIPPED", ""),
+            "validator": os.getenv("INQUIRERPY_STYLE_VALIDATOR", ""),
+            "marker": os.getenv("INQUIRERPY_STYLE_MARKER", ""),
+            "fuzzy_prompt": os.getenv("INQUIRERPY_STYLE_FUZZY_PROMPT", ""),
+            "fuzzy_info": os.getenv("INQUIRERPY_STYLE_FUZZY_INFO", ""),
+            "fuzzy_border": os.getenv("INQUIRERPY_STYLE_FUZZY_BORDER", ""),
+            "fuzzy_match": os.getenv("INQUIRERPY_STYLE_FUZZY_MATCH", ""),
+            "spinner_pattern": os.getenv("INQUIRERPY_STYLE_SPINNER_PATTERN", ""),
+            "spinner_text": os.getenv("INQUIRERPY_STYLE_SPINNER_TEXT", ""),
+            **style,
+        }
+
+    if result.get("fuzzy_border"):
+        result["frame.border"] = result.pop("fuzzy_border")
+    if result.get("validator"):
+        result["validation-toolbar"] = result.pop("validator")
+    result["bottom-toolbar"] = "noreverse"
+    return InquirerPyStyle(result)
+
+
+def calculate_height(
+    height: Optional[Union[int, str]],
+    max_height: Optional[Union[int, str]],
+    height_offset: int = 2,
+) -> Tuple[Optional[int], int]:
+    """Calculate the `height` and `max_height` for the main question contents.
+
+    Tip:
+        The parameter `height`/`max_height` can be specified by either a :class:`string` or :class:`int`.
+
+        When `height`/`max_height` is :class:`str`:
+            It will set the height to a percentage based on the value provided.
+            You can optionally add the '%' sign which will be ignored while processing.
+
+            Example: "60%" or "60" (60% of the current terminal visible lines)
+
+        When `height`/`max_height` is :class:`int`:
+            It will set the height to exact number of lines based on the value provided.
+
+            Example: 20 (20 lines in terminal)
+
+    Note:
+        If `max_height` is not provided or is None, the default `max_height` will be configured to `70%` for
+        best visual presentation in the terminal.
+
+    Args:
+        height: The desired height in either percentage as string or exact value as int.
+        max_height: Maximum acceptable height in either percentage as string or exact value as int.
+        height_offset: Height offset to apply to the height.
+
+    Returns:
+        A :class:`tuple` with the first value being the desired height and the second value being
+        the maximum height.
+
+    Raises:
+        InvalidArgument: The provided `height`/`max_height` is not able to to be converted to int.
+
+    Examples:
+        >>> calculate_height(height="60%", max_height="100%")
+    """
+    try:
+        _, term_lines = shutil.get_terminal_size()
+        term_lines = term_lines
+        if not height:
+            dimmension_height = None
+        else:
+            if isinstance(height, str):
+                height = height.replace("%", "")
+                height = int(height)
+                dimmension_height = (
+                    math.floor(term_lines * (height / 100)) - height_offset
+                )
+            else:
+                dimmension_height = height
+
+        if not max_height:
+            max_height = "70%" if not height else "100%"
+        if isinstance(max_height, str):
+            max_height = max_height.replace("%", "")
+            max_height = int(max_height)
+            dimmension_max_height = (
+                math.floor(term_lines * (max_height / 100)) - height_offset
+            )
+        else:
+            dimmension_max_height = max_height
+
+        if dimmension_height and dimmension_height > dimmension_max_height:
+            dimmension_height = dimmension_max_height
+        if dimmension_height and dimmension_height <= 0:
+            dimmension_height = 1
+        if dimmension_max_height <= 0:
+            dimmension_max_height = 1
+        return dimmension_height, dimmension_max_height
+
+    except ValueError:
+        raise InvalidArgument(
+            "prompt argument height/max_height needs to be type of an int or str"
+        )
+
+
+def patched_print(*values) -> None:
+    """Patched :func:`print` that can print values without interrupting the prompt.
+
+    See Also:
+        :func:`print`
+        :func:`~prompt_toolkit.application.run_in_terminal`
+
+    Args:
+        *values: Refer to :func:`print`.
+
+    Examples:
+        >>> patched_print("Hello World")
+    """
+
+    def _print():
+        print(*values)
+
+    run_in_terminal(_print)
+
+
+def color_print(
+    formatted_text: List[Tuple[str, str]], style: Optional[Dict[str, str]] = None
+) -> None:
+    """Print colored text leveraging :func:`~prompt_toolkit.shortcuts.print_formatted_text`.
+
+    This function automatically handles printing the text without interrupting the
+    current prompt.
+
+    Args:
+        formatted_text: A list of formatted_text.
+        style: Style to apply to `formatted_text` in :class:`dictionary` form.
+
+    Example:
+        >>> color_print(formatted_text=[("class:aa", "hello "), ("class:bb", "world")], style={"aa": "red", "bb": "blue"})
+        >>> color_print([("red", "yes"), ("", " "), ("blue", "no")])
+    """
+
+    def _print():
+        print_formatted_text(
+            FormattedText(formatted_text),
+            style=Style.from_dict(style) if style else None,
+        )
+
+    if get_app().is_running:
+        run_in_terminal(_print)
+    else:
+        _print()

InquirerPy/validator.py

@@ -0,0 +1,166 @@
+"""Module contains pre-built validators."""
+
+import re
+from pathlib import Path
+from typing import Optional
+
+from prompt_toolkit.validation import ValidationError, Validator
+
+__all__ = [
+    "PathValidator",
+    "EmptyInputValidator",
+    "PasswordValidator",
+    "NumberValidator",
+]
+
+
+class NumberValidator(Validator):
+    """:class:`~prompt_toolkit.validation.Validator` to validate if input is a number.
+
+    Args:
+        message: Error message to display in the validatation toolbar when validation failed.
+        float_allowed: Allow input to contain floating number (with decimal).
+    """
+
+    def __init__(
+        self, message: str = "Input should be a number", float_allowed: bool = False
+    ) -> None:
+        self._message = message
+        self._float_allowed = float_allowed
+
+    def validate(self, document) -> None:
+        """Check if user input is a valid number.
+
+        This method is used internally by `prompt_toolkit <https://python-prompt-toolkit.readthedocs.io/en/master/>`_.
+
+        See Also:
+            https://python-prompt-toolkit.readthedocs.io/en/master/pages/asking_for_input.html?highlight=validator#input-validation
+        """
+        try:
+            if self._float_allowed:
+                float(document.text)
+            else:
+                int(document.text)
+        except ValueError:
+            raise ValidationError(
+                message=self._message, cursor_position=document.cursor_position
+            )
+
+
+class PathValidator(Validator):
+    """:class:`~prompt_toolkit.validation.Validator` to validate if input is a valid filepath on the system.
+
+    Args:
+        message: Error message to display in the validatation toolbar when validation failed.
+        is_file: Explicitly check if the input is a valid file on the system.
+        is_dir: Explicitly check if the input is a valid directory/folder on the system.
+    """
+
+    def __init__(
+        self,
+        message: str = "Input is not a valid path",
+        is_file: bool = False,
+        is_dir: bool = False,
+    ) -> None:
+        self._message = message
+        self._is_file = is_file
+        self._is_dir = is_dir
+
+    def validate(self, document) -> None:
+        """Check if user input is a filepath that exists on the system based on conditions.
+
+        This method is used internally by `prompt_toolkit <https://python-prompt-toolkit.readthedocs.io/en/master/>`_.
+
+        See Also:
+            https://python-prompt-toolkit.readthedocs.io/en/master/pages/asking_for_input.html?highlight=validator#input-validation
+        """
+        path = Path(document.text).expanduser()
+        if self._is_file and not path.is_file():
+            raise ValidationError(
+                message=self._message,
+                cursor_position=document.cursor_position,
+            )
+        elif self._is_dir and not path.is_dir():
+            raise ValidationError(
+                message=self._message,
+                cursor_position=document.cursor_position,
+            )
+        elif not path.exists():
+            raise ValidationError(
+                message=self._message,
+                cursor_position=document.cursor_position,
+            )
+
+
+class EmptyInputValidator(Validator):
+    """:class:`~prompt_toolkit.validation.Validator` to validate if the input is empty.
+
+    Args:
+        message: Error message to display in the validatation toolbar when validation failed.
+    """
+
+    def __init__(self, message: str = "Input cannot be empty") -> None:
+        self._message = message
+
+    def validate(self, document) -> None:
+        """Check if user input is empty.
+
+        This method is used internally by `prompt_toolkit <https://python-prompt-toolkit.readthedocs.io/en/master/>`_.
+
+        See Also:
+            https://python-prompt-toolkit.readthedocs.io/en/master/pages/asking_for_input.html?highlight=validator#input-validation
+        """
+        if not len(document.text) > 0:
+            raise ValidationError(
+                message=self._message,
+                cursor_position=document.cursor_position,
+            )
+
+
+class PasswordValidator(Validator):
+    """:class:`~prompt_toolkit.validation.Validator` to validate password compliance.
+
+    Args:
+        message: Error message to display in the validatation toolbar when validation failed.
+        length: The minimum length of the password.
+        cap: Password should include at least one capital letter.
+        special: Password should include at least one special char "@$!%*#?&".
+        number: Password should include at least one number.
+    """
+
+    def __init__(
+        self,
+        message: str = "Input is not compliant with the password constraints",
+        length: Optional[int] = None,
+        cap: bool = False,
+        special: bool = False,
+        number: bool = False,
+    ) -> None:
+        password_pattern = r"^"
+        if cap:
+            password_pattern += r"(?=.*[A-Z])"
+        if special:
+            password_pattern += r"(?=.*[@$!%*#?&])"
+        if number:
+            password_pattern += r"(?=.*[0-9])"
+        password_pattern += r"."
+        if length:
+            password_pattern += r"{%s,}" % length
+        else:
+            password_pattern += r"*"
+        password_pattern += r"$"
+        self._re = re.compile(password_pattern)
+        self._message = message
+
+    def validate(self, document) -> None:
+        """Check if user input is compliant with the specified password constraints.
+
+        This method is used internally by `prompt_toolkit <https://python-prompt-toolkit.readthedocs.io/en/master/>`_.
+
+        See Also:
+            https://python-prompt-toolkit.readthedocs.io/en/master/pages/asking_for_input.html?highlight=validator#input-validation
+        """
+        if not self._re.match(document.text):
+            raise ValidationError(
+                message=self._message, cursor_position=document.cursor_position
+            )

inquirerprompt-0.3.0.dist-info/METADATA

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: InquirerPrompt
+Version: 0.3.0
+Summary: Python port of Inquirer.js — a collection of common interactive command-line user interfaces (community-maintained fork of InquirerPy)
+License: MIT
+License-File: LICENSE
+Keywords: cli,prompt-toolkit,commandline,inquirer,development,interactive,prompt
+Author: Kevin Zhuang
+Author-email: kevin7441@gmail.com
+Maintainer: Tobias Hochgürtel
+Maintainer-email: tobiashochguertel@users.noreply.github.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: User Interfaces
+Provides-Extra: docs
+Requires-Dist: Sphinx (>=4.1.2,<5.0.0) ; extra == "docs"
+Requires-Dist: furo (>=2021.8.17b43,<2022.0.0) ; extra == "docs"
+Requires-Dist: myst-parser (>=0.15.1,<0.16.0) ; extra == "docs"
+Requires-Dist: pfzy (>=0.3.1,<0.4.0)
+Requires-Dist: prompt-toolkit (>=3.0.1,<4.0.0)
+Requires-Dist: sphinx-autobuild (>=2021.3.14,<2022.0.0) ; extra == "docs"
+Requires-Dist: sphinx-copybutton (>=0.4.0,<0.5.0) ; extra == "docs"
+Project-URL: Documentation, https://InquirerPrompt.readthedocs.io
+Project-URL: Repository, https://github.com/tobiashochguertel/InquirerPy
+Description-Content-Type: text/markdown
+
+# InquirerPy (published as **InquirerPrompt**)
+
+> **🍴 Community-Maintained Fork**
+>
+> This is a community fork of [kazhala/InquirerPy](https://github.com/kazhala/InquirerPy), maintained at
+> [`tobiashochguertel/InquirerPy`](https://github.com/tobiashochguertel/InquirerPy).
+>
+> The original project is a fantastic library that we rely on and deeply appreciate. Unfortunately the upstream
+> has been quiet for some time, and the community has accumulated valuable bug fixes, compatibility updates,
+> and feature contributions that have not been reviewed or merged. Rather than letting those improvements go to
+> waste, we decided to maintain this fork so that InquirerPy stays healthy and up-to-date for everyone.
+>
+> **Our goal is to contribute all improvements back upstream** — if the original author becomes active again
+> we will happily defer to them. Until then, we are keeping the lights on here. 🙏
+>
+> | Item | Detail |
+> |------|--------|
+> | Upstream | [kazhala/InquirerPy](https://github.com/kazhala/InquirerPy) @ `0.3.4` (last commit Nov 2022) |
+> | This fork | [tobiashochguertel/InquirerPy](https://github.com/tobiashochguertel/InquirerPy) |
+> | Install | `pip install InquirerPrompt` (import still: `import InquirerPy`) |
+> | Docs | [InquirerPrompt.readthedocs.io](https://InquirerPrompt.readthedocs.io) |
+>
+> If you are the original author and would like to resume ownership or collaborate, please open an issue — we
+> would love to work together!
+
+---
+
+[![CI](https://github.com/tobiashochguertel/InquirerPy/workflows/CI/badge.svg)](https://github.com/tobiashochguertel/InquirerPy/actions?query=workflow%3ACI)
+[![Coverage](https://codecov.io/gh/tobiashochguertel/InquirerPy/branch/master/graph/badge.svg)](https://codecov.io/gh/tobiashochguertel/InquirerPy)
+[![Version](https://img.shields.io/pypi/pyversions/InquirerPrompt)](https://pypi.org/project/InquirerPrompt/)
+[![PyPi](https://img.shields.io/pypi/v/InquirerPrompt)](https://pypi.org/project/InquirerPrompt/)
+[![Upstream](https://img.shields.io/badge/upstream-kazhala%2FInquirerPy-blue)](https://github.com/kazhala/InquirerPy)
+
+Documentation: [InquirerPrompt.readthedocs.io](https://InquirerPrompt.readthedocs.io)
+
+<!-- start intro -->
+
+## Introduction
+
+`InquirerPy` is a Python port of the famous [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/) (A collection of common interactive command line user interfaces).
+This project is a re-implementation of the [PyInquirer](https://github.com/CITGuru/PyInquirer) project, with bug fixes of known issues, new prompts, backward compatible APIs
+as well as more customisation options.
+
+<!-- end intro -->
+
+![Demo](https://github.com/kazhala/gif/blob/master/InquirerPy-demo.gif)
+
+## Motivation
+
+[PyInquirer](https://github.com/CITGuru/PyInquirer) is a great Python port of [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/), however, the project is slowly reaching
+to an unmaintained state with various issues left behind and no intention to implement more feature requests. I was heavily relying on this library for other projects but
+could not proceed due to the limitations.
+
+Some noticeable ones that bother me the most:
+
+- hard limit on `prompt_toolkit` version 1.0.3
+- various color issues
+- various cursor issues
+- No options for VI/Emacs navigation key bindings
+- Pagination option doesn't work
+
+This project uses python3.7+ type hinting with focus on resolving above issues while providing greater customisation options.
+
+## Requirements
+
+### OS
+
+Leveraging [prompt_toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit), `InquirerPy` works cross platform for all OS. Although Unix platform may have a better experience than Windows.
+
+### Python
+
+```
+python >= 3.7
+```
+
+## Getting Started
+
+Checkout full documentation **[here](https://InquirerPrompt.readthedocs.io/)**.
+
+### Install
+
+```sh
+pip3 install InquirerPy
+```
+
+### Quick Start
+
+#### Classic Syntax (PyInquirer)
+
+```python
+from InquirerPy import prompt
+
+questions = [
+    {"type": "input", "message": "What's your name:", "name": "name"},
+    {"type": "confirm", "message": "Confirm?", "name": "confirm"},
+]
+result = prompt(questions)
+name = result["name"]
+confirm = result["confirm"]
+```
+
+#### Alternate Syntax
+
+```python
+from InquirerPy import inquirer
+
+name = inquirer.text(message="What's your name:").execute()
+confirm = inquirer.confirm(message="Confirm?").execute()
+```
+
+<!-- start migration -->
+
+## Migrating from PyInquirer
+
+Most APIs from [PyInquirer](https://github.com/CITGuru/PyInquirer) should be compatible with `InquirerPy`. If you have discovered more incompatible APIs, please
+create an issue or directly update README via a pull request.
+
+### EditorPrompt
+
+`InquirerPy` does not support [editor](https://github.com/CITGuru/PyInquirer#editor---type-editor) prompt as of now.
+
+### CheckboxPrompt
+
+The following table contains the mapping of incompatible parameters.
+
+| PyInquirer      | InquirerPy      |
+| --------------- | --------------- |
+| pointer_sign    | pointer         |
+| selected_sign   | enabled_symbol  |
+| unselected_sign | disabled_symbol |
+
+### Style
+
+Every style keys from [PyInquirer](https://github.com/CITGuru/PyInquirer) is present in `InquirerPy` except the ones in the following table.
+
+| PyInquirer | InquirerPy |
+| ---------- | ---------- |
+| selected   | pointer    |
+
+Although `InquirerPy` support all the keys from [PyInquirer](https://github.com/CITGuru/PyInquirer), the styling works slightly different.
+Please refer to the [Style](https://InquirerPrompt.readthedocs.io/en/latest/pages/style.html) documentation for detailed information.
+
+<!-- end migration -->
+
+## Similar projects
+
+### questionary
+
+[questionary](https://github.com/tmbo/questionary) is a fantastic fork which supports `prompt_toolkit` 3.0.0+ with performance improvement and more customisation options.
+It's already a well established and stable library.
+
+Comparing with [questionary](https://github.com/tmbo/questionary), `InquirerPy` offers even more customisation options in styles, UI as well as key bindings. `InquirerPy` also provides a new
+and powerful [fuzzy](https://InquirerPrompt.readthedocs.io/en/latest/pages/prompts/fuzzy.html) prompt.
+
+### python-inquirer
+
+[python-inquirer](https://github.com/magmax/python-inquirer) is another great Python port of [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/). Instead of using `prompt_toolkit`, it
+leverages the library `blessed` to implement the UI.
+
+Before implementing `InquirerPy`, this library came up as an alternative. It's a more stable library comparing to the original [PyInquirer](https://github.com/CITGuru/PyInquirer), however
+it has a rather limited customisation options and an older UI which did not solve the issues I was facing described in the [Motivation](#Motivation) section.
+
+Comparing with [python-inquirer](https://github.com/magmax/python-inquirer), `InquirerPy` offers a slightly better UI,
+more customisation options in key bindings and styles, providing pagination as well as more prompts.
+
+## Credit
+
+This project is based on the great work done by the following projects & their authors.
+
+- [PyInquirer](https://github.com/CITGuru/PyInquirer)
+- [prompt_toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit)
+
+## License
+
+This project is licensed under [MIT](https://github.com/kazhala/InquirerPy/blob/master/LICENSE).
+