readchar-readpass 0.1.0__tar.gz

readchar_readpass-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shuraim Ibrahim Khan
+
+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.

readchar_readpass-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: readchar-readpass
+Version: 0.1.0
+Summary: A password reader.
+Project-URL: Homepage, https://github.com/Uchihashuraim/getpassword
+Author-email: Shuraim Ibrahim Khan <Uchihashuraim@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: readchar>=4.2.0
+Description-Content-Type: text/markdown
+
+# getpassword
+
+A small Python utility for reading masked password input from the terminal.
+
+This project provides a simple `get_password()` helper that accepts user input one character at a time, prints `*` for each keystroke, and supports backspace editing.
+
+## Features
+
+- Reads a password from the terminal without showing the raw characters
+- Displays `*` for each character typed
+- Supports backspace to correct mistakes
+- Minimal dependency footprint
+
+## Installation
+
+This project includes packaging metadata in `pyproject.toml`, so it can be installed with:
+
+```bash
+pip install getpassword
+```
+
+For local development from the repository, install in editable mode:
+
+```bash
+python -m pip install -e .
+```
+
+If you prefer a normal local install:
+
+```bash
+python -m pip install .
+```
+
+The package dependency `readchar` will be installed automatically.
+
+## Usage
+
+```python
+from getpassword import get_password
+
+password = get_password("Password: ")
+print("You entered", password)
+```
+
+You can also run the script directly from the repository:
+
+```bash
+python src/getpassword/getpassword.py
+```
+
+## Project structure
+
+- `src/getpassword/getpassword.py` - core password input implementation
+- `src/getpassword/__init__.py` - package entrypoint exposing `get_password`
+
+## Dependency
+
+- `readchar`
+
+## Notes
+
+This package is intended for simple console-based password entry. It does not provide advanced terminal handling or cross-platform terminal abstraction beyond the `readchar` dependency.

readchar_readpass-0.1.0/README.md

@@ -0,0 +1,62 @@
+# getpassword
+
+A small Python utility for reading masked password input from the terminal.
+
+This project provides a simple `get_password()` helper that accepts user input one character at a time, prints `*` for each keystroke, and supports backspace editing.
+
+## Features
+
+- Reads a password from the terminal without showing the raw characters
+- Displays `*` for each character typed
+- Supports backspace to correct mistakes
+- Minimal dependency footprint
+
+## Installation
+
+This project includes packaging metadata in `pyproject.toml`, so it can be installed with:
+
+```bash
+pip install getpassword
+```
+
+For local development from the repository, install in editable mode:
+
+```bash
+python -m pip install -e .
+```
+
+If you prefer a normal local install:
+
+```bash
+python -m pip install .
+```
+
+The package dependency `readchar` will be installed automatically.
+
+## Usage
+
+```python
+from getpassword import get_password
+
+password = get_password("Password: ")
+print("You entered", password)
+```
+
+You can also run the script directly from the repository:
+
+```bash
+python src/getpassword/getpassword.py
+```
+
+## Project structure
+
+- `src/getpassword/getpassword.py` - core password input implementation
+- `src/getpassword/__init__.py` - package entrypoint exposing `get_password`
+
+## Dependency
+
+- `readchar`
+
+## Notes
+
+This package is intended for simple console-based password entry. It does not provide advanced terminal handling or cross-platform terminal abstraction beyond the `readchar` dependency.

readchar_readpass-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "readchar-readpass"
+version = "0.1.0"
+description = "A password reader."
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name="Shuraim Ibrahim Khan", email="Uchihashuraim@gmail.com" },
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "readchar>=4.2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Uchihashuraim/getpassword"

readchar_readpass-0.1.0/src/readchar_readpass/__init__.py

@@ -0,0 +1,22 @@
+"""getpassword package.
+
+This package exposes a simple helper for obtaining a password from the
+user without echoing it to the terminal. It instead echos a '*' character for each character typed, and allows the user to use backspace to correct mistakes.
+"""
+
+from getpassword import getpass
+
+__all__ = ["get_password", "__version__"]
+__version__ = "0.1.0"
+
+
+def get_password(prompt: str = "Password: ") -> str:
+    """Read a password from stdin without echoing it.
+
+    Args:
+        prompt: The prompt text shown to the user.
+
+    Returns:
+        The entered password string.
+    """
+    return getpass(prompt)

readchar_readpass-0.1.0/src/readchar_readpass/getpassword.py

@@ -0,0 +1,20 @@
+import readchar 
+
+def getpass():
+    password = ""
+    while True:
+        char = readchar.readchar()
+        if char == '\r':
+            break
+        elif char == '\b':
+            password = password[:-1]
+            print('\b \b', end='', flush=True)
+        else:
+            password += char
+            print('*', end='', flush=True)
+    return password
+
+if __name__ == "__main__":
+    print("Enter your password: ", end='', flush=True)
+    password = getpass()
+    print("\nYour password is:", password)