pyinput-cli 0.1.0__tar.gz

pyinput_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pedro Alberto Rosquete Ares
+
+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.

pyinput_cli-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: pyinput-cli
+Version: 0.1.0
+Summary: A package for managing user input through the cli, and consistently across projects.
+Author-email: Pedro Alberto Rosquete Ares <rosquetearespedro06@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Pedro Alberto Rosquete Ares
+        
+        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.
+        
+Project-URL: Documentation, https://github.com/prares-dev/pyinput-cli.git
+Project-URL: Homepage, https://github.com/prares-dev/pyinput-cli.git
+Project-URL: Repository, https://github.com/prares-dev/pyinput-cli.git
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# pyinput-cli
+**The definitive input handler for your python cli programs.**
+
+pyinput-cli is a package that provides functions to handle user input in a consistent way across any project.
+
+- **get_str**: reads a string and can validate its length or its format as a name.
+- **get_num**: reads an integer or float and validates minimum and maximum values.
+- **yes_no**: asks a yes/no question and returns the boolean result.
+
+## Example usage
+
+```python
+from pyinput import get_num, get_str, yes_no
+
+name = get_str("Name: ", name=True, max_length=30)
+age = get_num("Age: ", min_val=0, max_val=120)
+continue_ = yes_no("Continue?")
+
+print(name, age, continue_)
+```
+
+## Notes
+
+- Empty strings are rejected by default for `get_str`.
+- `get_num` rejects invalid input and values outside the configured bounds.
+- The functions are designed for small interactive CLI flows and can be reused in larger projects.

pyinput_cli-0.1.0/README.md

@@ -0,0 +1,26 @@
+# pyinput-cli
+**The definitive input handler for your python cli programs.**
+
+pyinput-cli is a package that provides functions to handle user input in a consistent way across any project.
+
+- **get_str**: reads a string and can validate its length or its format as a name.
+- **get_num**: reads an integer or float and validates minimum and maximum values.
+- **yes_no**: asks a yes/no question and returns the boolean result.
+
+## Example usage
+
+```python
+from pyinput import get_num, get_str, yes_no
+
+name = get_str("Name: ", name=True, max_length=30)
+age = get_num("Age: ", min_val=0, max_val=120)
+continue_ = yes_no("Continue?")
+
+print(name, age, continue_)
+```
+
+## Notes
+
+- Empty strings are rejected by default for `get_str`.
+- `get_num` rejects invalid input and values outside the configured bounds.
+- The functions are designed for small interactive CLI flows and can be reused in larger projects.

pyinput_cli-0.1.0/pyinput/__init__.py

@@ -0,0 +1,5 @@
+"""Public package interface for PyInput."""
+
+from .pyinput import get_num, get_str, yes_no
+
+__all__ = ["get_str", "get_num", "yes_no"]

pyinput_cli-0.1.0/pyinput/pyinput.py

@@ -0,0 +1,129 @@
+import math
+from dataclasses import dataclass
+from typing import Any, Callable, Optional, Tuple
+
+
+@dataclass
+class Validator:
+    """ Generic object for reusable validation flow and harden input handling. """
+    parser: Callable[[str], Any]
+    is_valid: Callable[[Any], Tuple[True, Any] | Tuple[False, str]]
+    error_message: str = "Invalid input"
+    max_attempts: Optional[int] = None
+
+    def prompt(self, prompt_text: str):
+        attempts = 0
+
+        while True:
+            if self.max_attempts is not None and attempts >= self.max_attempts:
+                raise ValueError("Maximum number of attempts reached.")
+
+            try:
+                raw = input(prompt_text)
+            except (EOFError, KeyboardInterrupt):
+                raise
+
+            attempts += 1
+
+            try:
+                value = self.parser(raw)
+            except (TypeError, ValueError, OverflowError):
+                print(self.error_message)
+                continue
+
+            valid, result = self.is_valid(value)
+            if valid:
+                return result
+
+            print(result if isinstance(result, str) else self.error_message)
+
+
+# ==================== STRING ====================
+def get_str(prompt="Text: ", *, max_length=50, name=False, allow_empty=False):
+    """
+    Asks the user for a string until a valid one is given.
+
+    If name=True, the input is normalized as a title-cased name and restricted
+    to letters and spaces. If allow_empty=True, blank values are accepted.
+    """
+
+    def parser(raw):
+        return " ".join(raw.split())
+
+    def is_valid(value):
+        value = " ".join(value.split())
+
+        if not value and not allow_empty:
+            return False, "Input cannot be empty. Try Again."
+
+        if len(value) > max_length:
+            return False, f"You exceeded the maximum length ({max_length}). Try Again."
+
+        if name:
+            normalized = value.title()
+            if _has_invalid_characters(normalized):
+                return False, "Invalid characters detected, use only letters and whitespaces. Try Again."
+            return True, normalized
+
+        return True, value
+
+    return Validator(parser=parser, is_valid=is_valid).prompt(prompt)
+
+
+# helper function
+def _has_invalid_characters(text):
+    """Check if text contains non-alphabetic characters (except spaces)."""
+    return any(char != " " and not char.isalpha() for char in text)
+
+
+# ==================== NUMBER (int or float) ====================
+def get_num(prompt, *, min_val=None, max_val=None, floating=False):
+    """
+    Asks the user for a number until a valid one is given.
+    It validates in the range:
+        (-Infinite - max_val) if min_val is None
+        (min_val - Infinite) if max_val is None
+        (min_val - max_val) if both are given
+    If floating is True, it accepts floating point numbers, otherwise only integers.
+    """
+
+    def parser(raw):
+        return float(raw) if floating else int(raw)
+
+    def is_valid(value):
+        if floating and not math.isfinite(value):
+            return False, f"You didn't insert a valid {'float' if floating else 'integer'}. Try again."
+
+        if (min_val is not None and value < min_val) or (max_val is not None and value > max_val):
+            lower = min_val if min_val is not None else "-Infinite"
+            upper = max_val if max_val is not None else "Infinite"
+            return False, f"You inserted a number out of the valid range [{lower} - {upper}]"
+
+        return True, value
+
+    return Validator(
+        parser=parser,
+        is_valid=is_valid,
+        error_message=f"You didn't insert a valid {'float' if floating else 'integer'}. Try again.",
+    ).prompt(prompt)
+
+
+# ==================== BOOLEAN LOGIC ====================
+def yes_no(prompt):
+    """Asks the user a yes/no question and returns True for yes and False for no."""
+
+    def parser(raw):
+        return raw.strip().lower()
+
+    def is_valid(value):
+        if value in ["y", "yes"]:
+            return True, True
+        if value in ["n", "no"]:
+            return True, False
+        return False, "Invalid input. Please enter 'y' or 'n'."
+
+    return Validator(
+        parser=parser, 
+        is_valid=is_valid, 
+        error_message="Invalid input. Please enter 'y' or 'n'."
+        ).prompt(prompt + " (y/n): ")

pyinput_cli-0.1.0/pyinput_cli.egg-info/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: pyinput-cli
+Version: 0.1.0
+Summary: A package for managing user input through the cli, and consistently across projects.
+Author-email: Pedro Alberto Rosquete Ares <rosquetearespedro06@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Pedro Alberto Rosquete Ares
+        
+        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.
+        
+Project-URL: Documentation, https://github.com/prares-dev/pyinput-cli.git
+Project-URL: Homepage, https://github.com/prares-dev/pyinput-cli.git
+Project-URL: Repository, https://github.com/prares-dev/pyinput-cli.git
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# pyinput-cli
+**The definitive input handler for your python cli programs.**
+
+pyinput-cli is a package that provides functions to handle user input in a consistent way across any project.
+
+- **get_str**: reads a string and can validate its length or its format as a name.
+- **get_num**: reads an integer or float and validates minimum and maximum values.
+- **yes_no**: asks a yes/no question and returns the boolean result.
+
+## Example usage
+
+```python
+from pyinput import get_num, get_str, yes_no
+
+name = get_str("Name: ", name=True, max_length=30)
+age = get_num("Age: ", min_val=0, max_val=120)
+continue_ = yes_no("Continue?")
+
+print(name, age, continue_)
+```
+
+## Notes
+
+- Empty strings are rejected by default for `get_str`.
+- `get_num` rejects invalid input and values outside the configured bounds.
+- The functions are designed for small interactive CLI flows and can be reused in larger projects.

pyinput_cli-0.1.0/pyinput_cli.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+pyinput/__init__.py
+pyinput/pyinput.py
+pyinput_cli.egg-info/PKG-INFO
+pyinput_cli.egg-info/SOURCES.txt
+pyinput_cli.egg-info/dependency_links.txt
+pyinput_cli.egg-info/requires.txt
+pyinput_cli.egg-info/top_level.txt

pyinput_cli-0.1.0/pyinput_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pyinput_cli-0.1.0/pyinput_cli.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[dev]
+pytest>=8.0

pyinput_cli-0.1.0/pyinput_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+pyinput

pyinput_cli-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyinput-cli"
+version = "0.1.0"
+description = "A package for managing user input through the cli, and consistently across projects."
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [{name = "Pedro Alberto Rosquete Ares", email = "rosquetearespedro06@gmail.com"}]
+license = { file = "LICENSE" }
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/prares-dev/pyinput-cli.git"
+Homepage = "https://github.com/prares-dev/pyinput-cli.git"
+Repository = "https://github.com/prares-dev/pyinput-cli.git"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0",]
+
+[tool.setuptools.packages.find]
+include = ["pyinput*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ['.']
+addopts = "-ra"

pyinput_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+