simple-text-ui 0.0.1__tar.gz

simple_text_ui-0.0.1/LICENSE.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2026-present U.N. Owen <void@some.where>
+
+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.

simple_text_ui-0.0.1/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.5
+Name: simple-text-ui
+Version: 0.0.1
+Summary: A package to imlement a commonly used textual UI
+Author-email: Daniel Brusilovksy <brusilovskydaniel3@gmail.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# Simple Text UI
+
+[![PyPI - Version](https://img.shields.io/pypi/v/simple-text-ui.svg)](https://pypi.org/project/simple-text-ui)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/simple-text-ui.svg)](https://pypi.org/project/simple-text-ui)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+- [Information](#information)
+
+## Installation
+
+```console
+pip install simple-text-ui
+```
+
+## License
+
+`simple-text-ui` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+## Information
+
+`simple-text-ui` is a package that creates an object-oriented interface for one kind of textual UI used by beginner programs. This package is designed to make coding that interface much easier.

simple_text_ui-0.0.1/README.md

@@ -0,0 +1,27 @@
+# Simple Text UI
+
+[![PyPI - Version](https://img.shields.io/pypi/v/simple-text-ui.svg)](https://pypi.org/project/simple-text-ui)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/simple-text-ui.svg)](https://pypi.org/project/simple-text-ui)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+- [Information](#information)
+
+## Installation
+
+```console
+pip install simple-text-ui
+```
+
+## License
+
+`simple-text-ui` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+
+## Information
+
+`simple-text-ui` is a package that creates an object-oriented interface for one kind of textual UI used by beginner programs. This package is designed to make coding that interface much easier.

simple_text_ui-0.0.1/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "simple-text-ui"
+dynamic = ["version"]
+description = 'A package to imlement a commonly used textual UI'
+readme = "README.md"
+requires-python = ">=3.8"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Daniel Brusilovksy", email = "brusilovskydaniel3@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = []
+
+[tool.hatch.version]
+path = "src/simple_text_ui/__about__.py"
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/simple_text_ui tests}"
+
+[tool.coverage.run]
+source_pkgs = ["simple_text_ui", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/simple_text_ui/__about__.py",
+]
+
+[tool.coverage.paths]
+simple_text_ui = ["src/simple_text_ui", "*/simple-text-ui/src/simple_text_ui"]
+tests = ["tests", "*/simple-text-ui/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

simple_text_ui-0.0.1/src/simple_text_ui/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2026-present Daniel Brusilovsky <brusilovskydaniel3@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "0.0.1"

simple_text_ui-0.0.1/src/simple_text_ui/__init__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2026-present Daniel Brusilovsky <brusilovskydaniel3@gmail.com>
+#
+# SPDX-License-Identifier: MIT
+from text_ui import TextUI

simple_text_ui-0.0.1/src/simple_text_ui/text_ui.py

@@ -0,0 +1,75 @@
+import typing
+import sys
+
+
+class TextUI:
+    """A class to implement a commonly used format for textual GUI
+        This class uses __doc__(descriptions) as descriptions in the UI"""
+
+    options_template: str = "\n{title}\n\n{options}"
+
+    option_template: str = "{num}: {name}\n"
+
+    def __init__(self, title: str, auto_quit: bool = True):
+        """Takes a title and an optional auto_quit parameter,
+            default is to bind a basic quit method"""
+        self.title = title
+        self.auto_quit = auto_quit
+        self.bindings: typing.Dict[int, typing.Callable] = dict()
+        # Stores the next available integer option int
+        self._next_option: int = 0
+        # Binds default quit if specified
+        if self.auto_quit:
+            self.bind(self._quit)
+
+    def _quit(self):
+        "Quit"
+        sys.exit()
+
+    def bind(self, func: typing.Callable) -> None:
+        """Bind a callable object to an option integer.
+            Callable must have a description"""
+        if (not callable(func)) or (not func.__doc__):
+            raise TypeError("Invalid func. Did you forget a description?")
+        self.bindings[self._next_option] = func
+        self._next_option += 1
+
+    def loop(self) -> None:
+        """Main loop, builds table and runs chosen callable"""
+        while True:
+            self.build_table()
+            self.run_func(self.get_choice())
+
+    def build_table(self) -> None:
+        """Create a table of options to choose from"""
+        options: typing.List[str] = [
+            self.option_template.format(num=num, name=name.__doc__)
+            for num, name in self.bindings.items()
+        ]
+        print(self.options_template.format(title=self.title,\
+                                           options="".join(options)))
+
+    def get_choice(self) -> int:
+        """Get the user's chosen function"""
+        choice: str = "_invalid_string"
+        while self._invalid_choice(choice):
+            choice = input("Enter your choice: ")
+            if self._invalid_choice(choice):
+                print("Invalid choice. Please try again.\n")
+            else:
+                print()
+        return int(choice)
+
+    def run_func(self, choice: int) -> None:
+        """Run the chosen function"""
+        self.bindings[choice]()
+
+    def _invalid_choice(self, choice: str | int) -> bool:
+        """Check if a choice is invalid"""
+        try:
+            choice = int(choice)
+        except:
+            return True
+        if choice not in self.bindings.keys():
+            return True
+        return False

simple_text_ui-0.0.1/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2026-present Daniel Brusilovsky <brusilovskydaniel3@gmail.com>
+#
+# SPDX-License-Identifier: MIT