typio 0.0.0__py3-none-any.whl → 0.2__py3-none-any.whl

typio/__init__.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+"""typio modules."""
+from .params import TYPIO_VERSION, TypeMode
+from .errors import TypioError
+from .functions import type_print, typestyle
+
+__version__ = TYPIO_VERSION
+__all__ = ["TypeMode", "TypioError", "type_print", "typestyle"]

typio/__main__.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+"""typio main."""
+
+if __name__ == "__main__":
+    pass

typio/errors.py

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+"""typio errors."""
+
+
+class TypioError(Exception):
+    """Base class for errors in Typio."""
+
+    pass

typio/functions.py

@@ -0,0 +1,245 @@
+# -*- coding: utf-8 -*-
+"""typio functions."""
+
+import sys
+import time
+import random
+import re
+from functools import wraps
+from io import TextIOBase
+from typing import Any, Callable, Optional
+from .params import TypeMode
+from .params import INVALID_TEXT_ERROR, INVALID_BYTE_ERROR, INVALID_DELAY_ERROR
+from .params import INVALID_JITTER_ERROR, INVALID_MODE_ERROR, INVALID_FILE_ERROR
+from .params import INVALID_END_ERROR
+from .errors import TypioError
+
+
+def _validate(
+    text: Any,
+    delay: Any,
+    jitter: Any,
+    mode: Any,
+    end: Any,
+    file: Any,
+) -> str:
+    """
+    Validate and normalize inputs for typing operations.
+
+    :param text: text to be printed
+    :param delay: base delay (in seconds) between emitted units
+    :param jitter: random jitter added/subtracted from delay
+    :param mode: typing mode controlling emission granularity
+    :param end: end character(s)
+    :param file: output stream supporting a write() method
+    """
+    if not isinstance(text, (str, bytes)):
+        raise TypioError(INVALID_TEXT_ERROR)
+
+    if isinstance(text, bytes):
+        try:
+            text = text.decode()
+        except Exception:
+            raise TypioError(INVALID_BYTE_ERROR)
+
+    if not isinstance(delay, (int, float)) or delay < 0:
+        raise TypioError(INVALID_DELAY_ERROR)
+
+    if not isinstance(jitter, (int, float)) or jitter < 0:
+        raise TypioError(INVALID_JITTER_ERROR)
+
+    if not isinstance(mode, TypeMode):
+        raise TypioError(INVALID_MODE_ERROR)
+
+    if not isinstance(end, str):
+        raise TypioError(INVALID_END_ERROR)
+
+    if file is not None and not hasattr(file, "write"):
+        raise TypioError(INVALID_FILE_ERROR)
+    text = f"{text}{end}"
+    return text
+
+
+def _sleep(delay: float, jitter: float) -> None:
+    """
+    Sleep for a given delay with optional random jitter.
+
+    :param delay: base delay (in seconds) between emitted units
+    :param jitter: random jitter added/subtracted from delay
+    """
+    if delay <= 0:
+        return
+    if jitter:
+        delay += random.uniform(-jitter, jitter)
+        delay = max(0, delay)
+    time.sleep(delay)
+
+
+class _TypioPrinter:
+    """File-like object that emits text with typing effects."""
+
+    def __init__(self, *, delay: float, jitter: float, mode: TypeMode, out: TextIOBase) -> None:
+        """
+        Initialize the typing printer.
+
+        :param delay: base delay (in seconds) between emitted units
+        :param jitter: random jitter added/subtracted from delay
+        :param mode: typing mode controlling emission granularity
+        :param out: underlying output stream
+        """
+        self.delay = delay
+        self.jitter = jitter
+        self.mode = mode
+        self.out = out
+
+    def write(self, text: str) -> None:
+        """
+        Write text using the configured typing mode.
+
+        :param text: text to be written
+        """
+        handler = getattr(self, "_mode_{mode}".format(mode=self.mode.value))
+        handler(text)
+
+    def flush(self) -> None:
+        """Flush the underlying output stream."""
+        self.out.flush()
+
+    def _emit(self, part: str, delay: Optional[float] = None) -> None:
+        """
+        Emit a text fragment and apply delay.
+
+        :param part: text fragment to write
+        :param delay: optional override delay for this fragment
+        """
+        self.out.write(part)
+        self.out.flush()
+        _sleep(delay if delay is not None else self.delay, self.jitter)
+
+    def _mode_char(self, text: str) -> None:
+        """
+        Emit text character by character.
+
+        :param text: text to emit
+        """
+        for c in text:
+            self._emit(c)
+
+    def _mode_word(self, text: str) -> None:
+        """
+        Emit text word by word, preserving whitespace.
+
+        :param text: text to emit
+        """
+        for w in re.findall(r"\S+|\s+", text):
+            self._emit(w)
+
+    def _mode_line(self, text: str) -> None:
+        """
+        Emit text line by line.
+
+        :param text: text to emit
+        """
+        for line in text.splitlines(True):
+            self._emit(line)
+
+    def _mode_sentence(self, text: str) -> None:
+        """
+        Emit text character by character with longer pauses after sentence-ending punctuation.
+
+        :param text: text to emit
+        """
+        for c in text:
+            self._emit(c)
+            if c in ".!?":
+                _sleep(self.delay * 4, self.jitter)
+
+    def _mode_typewriter(self, text: str) -> None:
+        """
+        Emit text character by character with longer pauses after newlines.
+
+        :param text: text to emit
+        """
+        for c in text:
+            self._emit(c)
+            if c == "\n":
+                _sleep(self.delay * 5, self.jitter)
+
+    def _mode_adaptive(self, text: str) -> None:
+        """
+        Emit text with adaptive delays based on character type.
+
+        :param text: text to emit
+        """
+        for c in text:
+            d = self.delay * (
+                0.3 if c.isspace()
+                else 1.5 if not c.isalnum()
+                else 1
+            )
+            self._emit(c, d)
+
+
+def type_print(
+        text: str,
+        *,
+        delay: float = 0.04,
+        jitter: float = 0,
+        end: str = "\n",
+        mode: TypeMode = TypeMode.CHAR,
+        file: Optional[TextIOBase] = None) -> None:
+    """
+    Print text with typing effects.
+
+    :param text: text to be printed
+    :param delay: base delay (in seconds) between emitted units
+    :param jitter: random jitter added/subtracted from delay
+    :param end: end character(s)
+    :param mode: typing mode controlling emission granularity
+    :param file: output stream supporting a write() method
+    """
+    text = _validate(text, delay, jitter, mode, end, file)
+    out = file or sys.stdout
+
+    printer = _TypioPrinter(
+        delay=delay,
+        jitter=jitter,
+        mode=mode,
+        out=out,
+    )
+    printer.write(text)
+    printer.flush()
+
+
+def typestyle(
+        *,
+        delay: float = 0.04,
+        jitter: float = 0,
+        mode: TypeMode = TypeMode.CHAR) -> Callable:
+    """
+    Apply typing effects to all print() calls inside the decorated function.
+
+    :param delay: base delay (in seconds) between emitted units
+    :param jitter: random jitter added/subtracted from delay
+    :param mode: typing mode controlling emission granularity
+    """
+    _validate("", delay, jitter, mode, "", sys.stdout)
+
+    def decorator(func: Callable) -> Callable:
+        @wraps(func)
+        def wrapper(*args: list, **kwargs: dict) -> Any:
+            old_stdout = sys.stdout
+            try:
+                sys.stdout = _TypioPrinter(
+                    delay=delay,
+                    jitter=jitter,
+                    mode=mode,
+                    out=old_stdout,
+                )
+                return func(*args, **kwargs)
+            finally:
+                sys.stdout = old_stdout
+
+        return wrapper
+
+    return decorator

typio/params.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+"""typio params."""
+from enum import Enum
+
+TYPIO_VERSION = "0.2"
+
+
+class TypeMode(Enum):
+    """Type mode enum."""
+
+    CHAR = "char"
+    WORD = "word"
+    LINE = "line"
+    SENTENCE = "sentence"
+    TYPEWRITER = "typewriter"
+    ADAPTIVE = "adaptive"
+
+
+INVALID_TEXT_ERROR = "`text` must be str or bytes."
+INVALID_BYTE_ERROR = "bytes text must be UTF-8 decodable."
+INVALID_DELAY_ERROR = "`delay` must be a non-negative number."
+INVALID_JITTER_ERROR = "`jitter` must be a non-negative number."
+INVALID_MODE_ERROR = "`mode` must be a TypeMode enum value."
+INVALID_END_ERROR = "`end` must be a str."
+INVALID_FILE_ERROR = "`file` must be a file-like object."

typio-0.2.dist-info/METADATA

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: typio
+Version: 0.2
+Summary: Typio: Make Your Terminal Type Like a Human
+Home-page: https://github.com/sepandhaghighi/typio
+Download-URL: https://github.com/sepandhaghighi/typio/tarball/v0.2
+Author: Sepand Haghighi
+Author-email: me@sepand.tech
+License: MIT
+Project-URL: Source, https://github.com/sepandhaghighi/typio
+Keywords: terminal cli typing typewriter typing-effect console stdout ux
+Classifier: Development Status :: 3 - Alpha
+Classifier: Natural Language :: English
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+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 :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Topic :: Terminals
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.md
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary
+
+
+<div align="center">
+<img src="https://github.com/sepandhaghighi/typio/raw/main/otherfiles/logo.png" width="320">
+<h1>Typio: Make Your Terminal Type Like a Human</h1>
+<br/>
+<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+<a href="https://github.com/sepandhaghighi/typio"><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/sepandhaghighi/typio"></a>
+<a href="https://badge.fury.io/py/typio"><img src="https://badge.fury.io/py/typio.svg" alt="PyPI version"></a>
+<a href="https://codecov.io/gh/sepandhaghighi/typio"><img src="https://codecov.io/gh/sepandhaghighi/typio/graph/badge.svg?token=UPhwanwQVw"></a>
+</div>			
+				
+## Overview	
+
+<p align="justify">
+Typio is a lightweight Python library that prints text to the terminal as if it were being typed by a human. It supports multiple typing modes (character, word, line, sentence, typewriter, and adaptive), configurable delays and jitter for natural variation, and seamless integration with existing code via a simple function or a decorator. Typio is designed to be minimal, extensible, and safe, making it ideal for demos, CLIs, tutorials, and storytelling in the terminal.
+</p>
+
+<table>
+	<tr>
+		<td align="center">PyPI Counter</td>
+		<td align="center"><a href="http://pepy.tech/project/typio"><img src="http://pepy.tech/badge/typio"></a></td>
+	</tr>
+	<tr>
+		<td align="center">Github Stars</td>
+		<td align="center"><a href="https://github.com/sepandhaghighi/typio"><img src="https://img.shields.io/github/stars/sepandhaghighi/typio.svg?style=social&label=Stars"></a></td>
+	</tr>
+</table>
+
+
+
+<table>
+	<tr> 
+		<td align="center">Branch</td>
+		<td align="center">main</td>	
+		<td align="center">dev</td>	
+	</tr>
+	<tr>
+		<td align="center">CI</td>
+		<td align="center"><img src="https://github.com/sepandhaghighi/typio/actions/workflows/test.yml/badge.svg?branch=main"></td>
+		<td align="center"><img src="https://github.com/sepandhaghighi/typio/actions/workflows/test.yml/badge.svg?branch=dev"></td>
+	</tr>
+</table>
+
+<table>
+    <tr> 
+        <td align="center">Code Quality</td>
+        <td align="center"><a href="https://www.codefactor.io/repository/github/sepandhaghighi/typio"><img src="https://www.codefactor.io/repository/github/sepandhaghighi/typio/badge" alt="CodeFactor"></a></td>
+        <td align="center"><a href="https://app.codacy.com/gh/sepandhaghighi/typio/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/e047db39052a4be2859f299dd7f7ce3c"></a></td>
+    </tr>
+</table>
+
+## Installation		
+
+### Source Code
+- Download [Version 0.2](https://github.com/sepandhaghighi/typio/archive/v0.2.zip) or [Latest Source](https://github.com/sepandhaghighi/typio/archive/dev.zip)
+- `pip install .`				
+
+### PyPI
+
+- Check [Python Packaging User Guide](https://packaging.python.org/installing/)     
+- `pip install typio==0.2`						
+
+
+## Usage
+
+### Function
+
+Use `type_print` function to print text with human-like typing effects. You can control the typing speed, randomness, mode, and output stream.
+
+```python
+from typio import type_print
+from typio import TypeMode
+
+type_print("Hello, world!")
+
+type_print(
+    "Typing with style and personality.",
+    delay=0.06,
+    jitter=0.02,
+	end="\n",
+    mode=TypeMode.ADAPTIVE,
+)
+```
+
+You can also redirect the output to any file-like object:
+
+```python
+with open("output.txt", "w") as file:
+    type_print("Saved with typing effects.", file=file)
+```
+
+### Decorator
+
+Use the `@typestyle` decorator to apply typing effects to all `print` calls inside a function, without changing the function's implementation.
+
+```python
+from typio import typestyle
+from typio import TypeMode
+
+@typestyle(delay=0.05, mode=TypeMode.TYPEWRITER)
+def intro():
+    print("Welcome to Typio.")
+    print("Every print is typed.")
+
+intro()
+```
+
+## Issues & Bug Reports			
+
+Just fill an issue and describe it. We'll check it ASAP!
+
+- Please complete the issue template
+
+## Show Your Support
+								
+<h3>Star This Repo</h3>					
+
+Give a ⭐️ if this project helped you!
+
+<h3>Donate to Our Project</h3>	
+
+<h4>Bitcoin</h4>
+1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
+<h4>Ethereum</h4>
+0xcD4Db18B6664A9662123D4307B074aE968535388
+<h4>Litecoin</h4>
+Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
+<h4>Doge</h4>
+DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
+<h4>Tron</h4>
+TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
+<h4>Ripple</h4>
+rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
+<h4>Binance Coin</h4>
+bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
+<h4>Tether</h4>
+0xcD4Db18B6664A9662123D4307B074aE968535388
+<h4>Dash</h4>
+Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
+<h4>Stellar</h4>		
+GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
+<h4>Zilliqa</h4>
+zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
+<h4>Coffeete</h4>
+<a href="http://www.coffeete.ir/opensource">
+<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;" />
+</a>
+
+
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+## [0.2] - 2026-02-04
+### Changed
+- `README.md` updated
+- `end` parameter added to `type_print` function
+- Test system modified
+## [0.1] - 2026-01-31
+### Added
+- `type_print` function
+- `typestyle` decorator
+- `CHAR` mode
+- `WORD` mode
+- `LINE` mode
+- `SENTENCE` mode
+- `TYPEWRITER` mode
+- `ADAPTIVE` mode
+
+[Unreleased]: https://github.com/sepandhaghighi/typio/compare/v0.2...dev
+[0.2]: https://github.com/sepandhaghighi/typio/compare/v0.1...v0.2
+[0.1]: https://github.com/sepandhaghighi/typio/compare/750c00e...v0.1
+
+
+

typio-0.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+typio/__init__.py,sha256=46OPTYQECaKgTjmo4UfK7VmgsNjcE5K2zM3QC8LmOWA,258
+typio/__main__.py,sha256=NXst2kL-xGtI3tNIxh-H3AOL3vyn8SPiR96fER5oxfE,79
+typio/errors.py,sha256=IC6YD8cW6bVc1f_4DlaIm_TlSgiTw292IeY8_ZO1Fwo,127
+typio/functions.py,sha256=IrdRPc3cGOQtkci_wiI9Z8ShaIk0arFmFcw8YOcSoR4,6950
+typio/params.py,sha256=d5w4oVZZKfAF1nEzUsvsqHYOObquFKfP72eoCuLCArY,679
+typio-0.2.dist-info/licenses/AUTHORS.md,sha256=IONT1m3fc49glmYk5CbN70OMYCArB_2E5gXVb-PETKg,181
+typio-0.2.dist-info/licenses/LICENSE,sha256=-eYKcwcJYZNHlmW-GcaTyv0U2goVRxkTf9rH095_EI0,1072
+typio-0.2.dist-info/METADATA,sha256=4sgCWHL5lERQVe4qXSqH_aEHB6vH3tfNxkWE2YQZXGc,7423
+typio-0.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+typio-0.2.dist-info/top_level.txt,sha256=Dp5VGIrBg-Gmk8fSWVXKSpwl-Dltacd0Q4dEoIzcReY,6
+typio-0.2.dist-info/RECORD,,

{typio-0.0.0.dist-info → typio-0.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

typio-0.2.dist-info/licenses/AUTHORS.md

@@ -0,0 +1,12 @@
+# Core Developers
+----------
+- [@sepandhaghighi](http://github.com/sepandhaghighi)
+
+
+# Other Contributors
+----------
+- [ChatGPT](https://chat.openai.com/) ++
+
+++ Graphic designer
+
+

typio-0.2.dist-info/licenses/LICENSE

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

typio-0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+typio

__init__.py

@@ -1,2 +0,0 @@
-# -*- coding: utf-8 -*-
-"""typio modules."""

typio-0.0.0.dist-info/METADATA

@@ -1,38 +0,0 @@
-Metadata-Version: 2.4
-Name: typio
-Version: 0.0.0
-Summary: This name has been reserved using Reserver
-Home-page: https://url.com
-Download-URL: https://download_url.com
-Author: Development Team
-Author-email: test@test.com
-License: MIT
-Project-URL: Source, https://github.com/source
-Keywords: python3 python reserve reserver reserved
-Classifier: Development Status :: 1 - Planning
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-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
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: download-url
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: requires-python
-Dynamic: summary
-
-
-## Overview
-typio is a Python library for doing awesome things.
-This name has been reserved using [Reserver](https://github.com/openscilab/reserver).

typio-0.0.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-__init__.py,sha256=dp1WVGy9szS2t1wXtJJunJ_xkXppAzLm8j592Fkd9ck,44
-typio-0.0.0.dist-info/METADATA,sha256=Z-yhuU0OHTK-BYAQQrBGu-6cK4tYFoC0u0Pb7M126Tg,1198
-typio-0.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-typio-0.0.0.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-typio-0.0.0.dist-info/RECORD,,

typio-0.0.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-