ADD: assets for README.md

BaggerFast · BaggerFast · commit 379ba3021489 · 2022-07-15T11:57:05.000+03:00
UPDATE: setup README.md
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -21,16 +21,11 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies (Unix like Os)
-        if: matrix.os != 'windows-latest'
+      - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install -r requirements.txt
           pip install pylint pycodestyle
-      - name: Install dependencies(Only windows)
-        if: matrix.os == 'windows-latest'
-        run: |
-          python -m pip install --upgrade pip
-          pip install windows-curses pycodestyle
       - name: Tests
         run: python -m unittest tests/creation.py
       - name: Pylint (Unix like Os)
diff --git a/.pylintrc b/.pylintrc
@@ -17,7 +17,7 @@ extension-pkg-whitelist=
 fail-on=
 
 # Specify a score threshold to be exceeded before program exits with error.
-fail-under=10.0
+fail-under=8.0
 
 # Files or directories to be skipped. They should be base names, not paths.
 ignore=CVS, venv
diff --git a/README.md b/README.md
@@ -1,10 +1,15 @@
 # PyConsoleMenu
 ![Language](https://img.shields.io/badge/Language-Python3.7+-blue.svg?style=flat)
-[![BUILD-STATUS](https://github.com/BaggerFast/Snake/workflows/CI/badge.svg)](https://github.com/BaggerFast/Snake/actions?query=workflow%3Aci)
+[![BUILD-STATUS](https://github.com/BaggerFast/PyConsoleMenu/workflows/CI/badge.svg)](https://github.com/BaggerFast/PyConsoleMenu/actions)
 
 A simple Python menu in the terminal using curses. 
 Ideal for people who want to quickly make a menu without writing their own complicated crutches. 
-Includes: SelectorMenu, MultipleSelectorMenu, FunctionalMenu
+Includes: SelectorMenu, MultipleSelectorMenu, FunctionalMenu.
+
+## Preview
+![Selector](https://github.com/BaggerFast/PyConsoleMenu/tree/main/assets/selector.gif)
+
+[See other](https://github.com/BaggerFast/PyConsoleMenu/tree/main/assets)
 
 ## Installation 💾
 - using pip
@@ -14,12 +19,17 @@ $ pip install py_menu_console
 
 - using GitHub *(требуется [git](https://git-scm.com/downloads))*
 ```
-$ git clone https://github.com/BaggerFast/PyConsoleMemu
+$ git clone https://github.com/BaggerFast/PyConsoleMenu
 $ cd PyConsoleMemu
 $ pip install -r requirements.txt
 ```
 
-## Usage example ⌨️
+## Additionally ⌨️
+- Docs in code
+- Type hints
+
+
+## Usage example 👨‍💻 
 ```py
 from py_menu_console import MultiSelectorMenu, FunctionalOption, SelectorMenu, FunctionalMenu
 
@@ -38,8 +48,8 @@ def selector():
 
 def functional():
     data = [
-        FunctionalOption('Cheburashka', lambda _: print('I am a Parrot')),
-        FunctionalOption('Parrot', lambda _: print('I am a Cheburashka')),
+        FunctionalOption('Cheburashka', lambda: print('I am a Parrot')),
+        FunctionalOption('Parrot', lambda: print('I am a Cheburashka')),
     ]
     menu = FunctionalMenu(data, title='Functional')
     ans = menu.input()
diff --git a/assets/functional.gif b/assets/functional.gif
diff --git a/assets/multi_selector.gif b/assets/multi_selector.gif
diff --git a/assets/selector.gif b/assets/selector.gif
diff --git a/examples/.gitkeep b/examples/.gitkeep
diff --git a/examples/example.py b/examples/example.py
@@ -15,8 +15,8 @@ def selector():
 
 def functional():
     data = [
-        FunctionalOption('Cheburashka', lambda _: print('I am a Parrot')),
-        FunctionalOption('Parrot', lambda _: print('I am a Cheburashka')),
+        FunctionalOption('Cheburashka', lambda: print('I am a Parrot')),
+        FunctionalOption('Parrot', lambda: print('I am a Cheburashka')),
     ]
     menu = FunctionalMenu(data, title='Functional')
     ans = menu.input()
diff --git a/py_menu_console/__init__.py b/py_menu_console/__init__.py
@@ -1,2 +1,2 @@
 from .menu import MultiSelectorMenu, FunctionalMenu, SelectorMenu
-from .misc import FunctionalOption, Option
+from .misc import FunctionalOption, Option
diff --git a/py_menu_console/base.py b/py_menu_console/base.py
@@ -12,7 +12,7 @@ class BaseMenu(ABC):
     :param options: a list of options to choose from
     :param title: (optional) a title above options list
     :param default_index: (optional) set this if the default selected option is not the first one
-    :param indicator: (optional) customize the selection indicator
+    :param indicator: (optional) customize the selection indicator.
     """
 
     def __init__(self, options: List[str], title: str = '', default_index: int = 0, indicator: str = "->") -> None:
@@ -100,6 +100,9 @@ def _draw_options(self, screen, max_x: int) -> None:
     # region Public
 
     def input(self) -> Any:
+        """
+        Return input info from menu
+        """
         return wrapper(self._run_loop)
 
     # endregion
diff --git a/py_menu_console/menu.py b/py_menu_console/menu.py
@@ -11,9 +11,12 @@ class SelectorMenu(BaseMenu):
     :param options: a list of options to choose from
     :param title: (optional) a title above options list
     :param default_index: (optional) set this if the default selected option is not the first one
-    :param indicator: (optional) customize the selection indicator
+    :param indicator: (optional) customize the selection indicator.
     """
 
+    def __init__(self, options: List[str], title: str = '', default_index: int = 0, indicator: str = "->") -> None:
+        super().__init__(options, title, default_index, indicator)
+
     def _get_selected(self) -> Option:
         return Option(name=self._options[self._index], index=self._index)
 
@@ -32,13 +35,13 @@ class MultiSelectorMenu(BaseMenu):
     :param title: (optional) a title above options list
     :param default_index: (optional) set this if the default selected option is not the first one
     :param indicator: (optional) customize the selection indicator
-    :param count: a number of max chosen options
+    :param count: a number of max chosen options.
     """
 
     def __init__(self, options: List[str], title: str = '',  default_index: int = 0, indicator: str = "->",
                  count: int = None) -> None:
 
-        count = len(options) if not count else count
+        count = len(options) if count <= 0 else count
         if 1 <= count > len(options):
             raise ValueError('Count  must be in [2, len(options)]')
 
@@ -78,7 +81,7 @@ def _get_selected(self) -> Union[List[Option], None]:
 
     # endregion
 
-    def input(self) -> list[Option]:
+    def input(self) -> List[Option]:
         """
         Return list of chosen options as Items
         """
@@ -92,7 +95,7 @@ class FunctionalMenu(BaseMenu):
     :param options: a list of options to choose from
     :param title: (optional) a title above options list
     :param default_index: (optional) set this if the default selected option is not the first one
-    :param indicator: (optional) customize the selection indicator
+    :param indicator: (optional) customize the selection indicator.
     """
 
     def __init__(self, options: List[FunctionalOption], title: str = '', default_index: int = 0,
diff --git a/py_menu_console/misc.py b/py_menu_console/misc.py
@@ -5,8 +5,8 @@
 
 class Option(NamedTuple):
     """
-    :param name: name of chosen item in menu
-    :param index: index of chosen item in menu
+    :param name: name of chosen item in a menu
+    :param index: index of chosen item in a menu.
     """
     name: str
     index: int
@@ -15,7 +15,7 @@ class Option(NamedTuple):
 class FunctionalOption(NamedTuple):
     """
     :param name: name of option
-    :param func: func of option, will be return after functional menu
+    :param func: func of option, will be return after a functional menu.
     """
     name: str
     func: Callable

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`from .menu import MultiSelectorMenu, FunctionalMenu, SelectorMenu`
`2`		`-from .misc import FunctionalOption, Option`
	`2`	`+from .misc import FunctionalOption, Option`