UPDATE: README.md

ADD: LICENSE.md, setup.cfg, setup.py

Author: BaggerFast

.github/workflows/main.yml

@@ -13,21 +13,28 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-        python-version: [3.8, 3.9, 3.10]
+        python-version: [3.7, 3.8, 3.9, "3.10"]
 
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Install dependencies (Unix like Os)
+        if: matrix.os != 'windows-latest'
         run: |
           python -m pip install --upgrade pip
           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
+      - name: Pylint (Unix like Os)
+        if: matrix.os != 'windows-latest'
         run: pylint **/*.py --fail-under 8
       - name: Pycodestyle
-          run: pycodestyle .
+        run: pycodestyle .

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 BaggerFast (Aleksandrov Daniil)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,54 @@
-# PyConsoleMenu
+# 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)
+
+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
+
+## Installation 💾
+- using pip
+```
+$ pip install py_menu_console
+```
+
+- using GitHub *(требуется [git](https://git-scm.com/downloads))*
+```
+$ git clone https://github.com/BaggerFast/PyConsoleMemu
+$ cd PyConsoleMemu
+$ pip install -r requirements.txt
+```
+
+## Usage example ⌨️
+```py
+from py_menu_console import MultiSelectorMenu, FunctionalOption, SelectorMenu, FunctionalMenu
+
+
+def multi_selector():
+    menu = MultiSelectorMenu(['Cheburashka', 'Parrot', 'Snake', 'Gena'], title='MultiSelector', count=3)
+    ans = menu.input()
+    print(ans)
+
+
+def selector():
+    menu = SelectorMenu(['Cheburashka', 'Parrot', 'Snake', 'Gena'], title='Selector')
+    ans = menu.input()
+    print(ans)
+
+
+def functional():
+    data = [
+        FunctionalOption('Cheburashka', lambda _: print('I am a Parrot')),
+        FunctionalOption('Parrot', lambda _: print('I am a Cheburashka')),
+    ]
+    menu = FunctionalMenu(data, title='Functional')
+    ans = menu.input()
+    ans()
+```
+*[See more examples](https://github.com/BaggerFast/PyConsoleMenu/tree/main/examples)*
+
+**Was written in these videos on YouTube 👀** \
+[Video#1](https://www.youtube.com/watch?v=wgK90PIzlng&t=118s) \
+[Stream#1](https://www.youtube.com/watch?v=7eHcjkM-mTs&t=6046s) \
+[Stream#2](https://www.youtube.com/watch?v=ppZoCcmPhpc&t=2941s)
+

examples/example.py

@@ -1,4 +1,4 @@
-from pymenu import MultiSelectorMenu, FunctionalOption, SelectorMenu, FunctionalMenu
+from py_menu_console import MultiSelectorMenu, FunctionalOption, SelectorMenu, FunctionalMenu
 
 
 def multi_selector():

pymenu/__init__.py renamed to 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

pymenu/base.py renamed to py_menu_console/base.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, List
 from abc import ABC
 from curses import wrapper, use_default_colors, curs_set
 import _curses
@@ -15,7 +15,7 @@ class BaseMenu(ABC):
     :param indicator: (optional) customize the selection indicator
     """
 
-    def __init__(self, options: list[str], title: str = '', default_index: int = 0, indicator: str = "->") -> None:
+    def __init__(self, options: List[str], title: str = '', default_index: int = 0, indicator: str = "->") -> None:
 
         # region parse Exceptions
 

pymenu/menu.py renamed to py_menu_console/menu.py

@@ -1,5 +1,5 @@
 import curses
-from typing import Callable, Union
+from typing import Callable, Union, List
 from .base import BaseMenu
 from .misc import Option, Keyboard, FunctionalOption
 
@@ -35,7 +35,7 @@ class MultiSelectorMenu(BaseMenu):
     :param count: a number of max chosen options
     """
 
-    def __init__(self, options: list[str], title: str = '',  default_index: int = 0, indicator: str = "->",
+    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
@@ -44,7 +44,7 @@ def __init__(self, options: list[str], title: str = '',  default_index: int = 0,
 
         super().__init__(options, title, default_index, indicator)
         self.__count = count
-        self.__selected: list[int] = []
+        self.__selected: List[int] = []
         self._control_config[Keyboard.SELECT] = self.__select
 
     # region Private
@@ -71,7 +71,7 @@ def _draw_options(self, screen, max_x: int) -> None:
                 screen.addnstr(self._y, 0, line, max_x)
             self._y += 1
 
-    def _get_selected(self) -> Union[list[Option], None]:
+    def _get_selected(self) -> Union[List[Option], None]:
         if not self.__selected:
             return
         return [Option(index=i, name=self._options[i]) for i in sorted(self.__selected)]
@@ -95,11 +95,11 @@ class FunctionalMenu(BaseMenu):
     :param indicator: (optional) customize the selection indicator
     """
 
-    def __init__(self, options: list[FunctionalOption], title: str = '', default_index: int = 0,
+    def __init__(self, options: List[FunctionalOption], title: str = '', default_index: int = 0,
                  indicator: str = "->") -> None:
 
-        self.__functions: list[Callable] = []
-        local_options: list[str] = []
+        self.__functions: List[Callable] = []
+        local_options: List[str] = []
         for option in options:
             self.__functions.append(option.func)
             local_options.append(option.name)

pymenu/misc.py renamed to py_menu_console/misc.py

@@ -1,6 +1,6 @@
 from abc import ABC
 from curses import KEY_UP, KEY_DOWN, KEY_ENTER
-from typing import NamedTuple, Final, Callable
+from typing import NamedTuple, Callable
 
 
 class Option(NamedTuple):
@@ -22,7 +22,7 @@ class FunctionalOption(NamedTuple):
 
 
 class Keyboard(ABC):
-    UP: Final = (KEY_UP, ord('w'))
-    DOWN: Final = (KEY_DOWN, ord('s'))
-    APPROVE: Final = (KEY_ENTER, ord('\n'))
-    SELECT: Final = (ord(' '),)
+    UP = (KEY_UP, ord('w'))
+    DOWN = (KEY_DOWN, ord('s'))
+    APPROVE = (KEY_ENTER, ord('\n'))
+    SELECT = (ord(' '),)

requirements.txt

@@ -0,0 +1 @@
+windows-curses; sys_platform=='win32'

setup.cfg

@@ -0,0 +1,3 @@
+[metadata]
+description-file=README.md
+license_files=LICENSE.md

setup.py

@@ -0,0 +1,33 @@
+from setuptools import setup
+
+setup(
+    name='py_console_menu',
+    version='1.0.0',
+    license='MIT',
+    author="BaggerFast (Aleksandrov Daniil)",
+    author_email='riosha3@gmail.com',
+    description='A simple console menu system using curses',
+    long_description='Contains: SelectorMenu, MultiSelectorMenu, FunctionalMenu',
+    url='https://github.com/BaggerFast/PyConsoleMenu',
+    downoload_url='?',
+    keywords='?',
+    install_requires=[
+        "widows-curses; sys_platform == 'win32'"
+    ],
+    python_requires='>=3.7',
+    classifiers=[
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python :: 3'
+        'Programming Language :: Python :: 3 :: Only',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: Implementation :: CPython',
+        'Programming Language :: Python :: Implementation :: PyPy',
+        'Programming Language :: Python',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+)

tests/creation.py

@@ -1,7 +1,7 @@
 from unittest import TestCase
 
-from pymenu.menu import SelectorMenu, MultiSelectorMenu, FunctionalMenu
-from pymenu.misc import FunctionalOption
+from py_menu_console.menu import SelectorMenu, MultiSelectorMenu, FunctionalMenu
+from py_menu_console.misc import FunctionalOption
 
 
 class TestCreation(TestCase):