stty 0.0.1__tar.gz

stty-0.0.1/LICENSE

@@ -0,0 +1,14 @@
+# Copyright (C) 2025 Soumendra Ganguly
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.

stty-0.0.1/PKG-INFO

@@ -0,0 +1,343 @@
+Metadata-Version: 2.4
+Name: stty
+Version: 0.0.1
+Summary: A Python library for manipulating terminal settings in the style of POSIX `stty(1)`.
+Author-email: Soumendra Ganguly <soumendraganguly@gmail.com>
+Maintainer-email: Soumendra Ganguly <soumendraganguly@gmail.com>
+License: # Copyright (C) 2025 Soumendra Ganguly
+        
+        # This program is free software: you can redistribute it and/or modify
+        # it under the terms of the GNU General Public License as published by
+        # the Free Software Foundation, either version 3 of the License, or
+        # (at your option) any later version.
+        
+        # This program is distributed in the hope that it will be useful,
+        # but WITHOUT ANY WARRANTY; without even the implied warranty of
+        # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        # GNU General Public License for more details.
+        
+        # You should have received a copy of the GNU General Public License
+        # along with this program.  If not, see <https://www.gnu.org/licenses/>.
+Project-URL: Homepage, https://github.com/8vasu/stty.py
+Project-URL: Issues, https://github.com/8vasu/stty.py/issues
+Keywords: terminal,tty,stty,termios,winsize,posix,terminal-settings,pseudo-terminal,pty,terminal-attributes
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Terminals
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Operating System
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+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 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# stty.py
+
+A Python library for manipulating terminal settings in the style of POSIX `stty(1)`.
+
+---
+
+## Overview
+
+`stty` provides a high-level, Pythonic interface to terminal I/O settings, including control characters, baud rates, and window size, using the `termios` and related modules. It allows you to get, set, save, and restore terminal attributes, and to apply them to file descriptors or pseudo-terminals.
+
+---
+
+## Features
+
+- Read and modify terminal attributes (iflag, oflag, cflag, lflag, control characters, speeds, window size)
+- Save and load settings to/from JSON files
+- Apply settings to file descriptors or pseudo-terminals
+- Symbolic and string-based access to all settings
+- Emulates many `stty(1)` features and modes (e.g., raw, evenp, oddp, nl, ek)
+- Cross-platform support (where `termios` is available)
+
+---
+
+## Installation
+
+This is a pure Python library. Place `stty.py` in your project or install via your preferred method.
+
+---
+
+## Examples
+
+### 1. Reading and Printing Terminal Settings
+
+```python
+from stty import Stty
+
+# Open terminal and get current settings from stdin (fd=0)
+tty = Stty(fd=0)
+print(tty)  # Print all settings in a compact form
+```
+
+---
+
+### 2. Setting Individual Attributes
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Turn off echo
+tty.echo = False
+
+# Set erase character to Ctrl-H
+tty.erase = "^H"
+
+# Set input baud rate to 9600
+tty.ispeed = 9600
+
+# Set number of rows in the terminal window (if supported)
+tty.rows = 40
+```
+
+---
+
+### 3. Setting Multiple Attributes at Once
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Set several attributes in one call
+tty.set(
+    echo=False,
+    icanon=False,
+    erase="^H",
+    ispeed=19200,
+    ospeed=19200,
+    rows=30,
+    cols=100
+)
+```
+
+---
+
+### 4. Saving and Loading Settings
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Save current settings to a file
+tty.save("my_tty_settings.json")
+
+# Later, restore settings from the file
+tty2 = Stty(path="my_tty_settings.json")
+tty2.tofd(0)  # Apply to stdin
+```
+
+---
+
+### 5. Using Raw Mode
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+tty.raw()         # Set raw mode
+tty.tofd(0)       # Apply to stdin
+```
+
+---
+
+### 6. Working with Pseudo-terminals
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+m, s, sname = tty.openpty()  # Open a new pty pair and apply settings to slave
+print(f"Master fd: {m}, Slave fd: {s}, Slave name: {sname}")
+```
+
+---
+
+### 7. Setting Control Characters
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Set interrupt character to Ctrl-C
+tty.intr = "^C"
+
+# Set end-of-file character to Ctrl-D
+tty.eof = "^D"
+
+# Set suspend character to DEL
+tty.susp = "^?"
+```
+
+---
+
+### 8. Querying Settings as a Dictionary
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+settings = tty.get()
+print(settings["echo"])   # True or False
+print(settings["erase"])  # e.g., '^H'
+```
+
+---
+
+### 9. Using Symbolic Constants
+
+```python
+from stty import Stty, cs8, tab0
+
+tty = Stty(fd=0)
+
+# Set character size to 8 bits using symbolic constant
+tty.csize = cs8
+
+# Set tab delay to tab0
+tty.tabdly = tab0
+```
+
+---
+
+### 10. Fork new process with pseudo-terminal
+
+```python
+x = stty.Stty(0)
+x.intr = "^p"
+pid, m, sname  = x.forkpty()
+
+if pid == 0: # Child process
+    with open("out", "w") as f:
+        f.write(str(stty.Stty(0)))
+else: # Parent process
+    print(sname)
+    print("")
+    s = os.open(sname, os.O_RDWR)
+    print("Parent:", stty.Stty(s))
+    os.close(s)
+```
+
+---
+
+## API Reference
+
+### Classes
+
+#### `Stty`
+
+Manipulate terminal settings in the style of `stty(1)`.
+
+**Constructor:**
+```python
+Stty(fd: int = None, path: str = None, **opts)
+```
+- `fd`: File descriptor to read settings from.
+- `path`: Path to JSON file to load settings from.
+- `**opts`: Any supported terminal attribute as a keyword argument.
+
+**Methods:**
+
+- `get() -> dict`
+  Return a dictionary of all current settings.
+
+- `set(**opts)`
+  Set multiple attributes at once.
+
+- `save(path: str = None)`
+  Save settings to a JSON file, or return a deep copy if no path is given.
+
+- `load(path: str)`
+  Load settings from a JSON file.
+
+- `fromfd(fd: int)`
+  Load settings from a file descriptor.
+
+- `tofd(fd: int, when=TCSANOW, apply_termios=True, apply_winsize=True)`
+  Apply settings to a file descriptor.
+
+- `evenp(plus=True)`
+  Set/unset even parity mode.
+
+- `oddp(plus=True)`
+  Set/unset odd parity mode.
+
+- `raw()`
+  Set terminal to raw mode.
+
+- `nl(plus=True)`
+  Set/unset nl combination mode.
+
+- `ek()`
+  Set ek combination mode.
+
+- `openpty(apply_termios=True, apply_winsize=True)`
+  Open a new pseudo-terminal pair and apply settings.
+
+- `forkpty(apply_termios=True, apply_winsize=True)`
+  Fork a new process with a pseudo-terminal and apply settings.
+
+**Attribute Access:**
+
+- All terminal attributes (e.g., `echo`, `icanon`, `erase`, `ispeed`, `rows`, etc.) are accessible as properties.
+- Setting an attribute updates the internal state and validates the value.
+
+---
+
+### Constants
+
+- `TCSANOW`, `TCSADRAIN`, `TCSAFLUSH`: the values accepted by the `when` named argument of `Stty.tofd()`. Compare with `termios.tcsetattr()`.
+- Symbolic constants for masks and values (e.g., `cs8`, `tab0`, etc.) are available as module attributes.
+
+---
+
+### Data
+
+- `settings`: A dictionary describing all available Stty attributes and their possible values on the current platform.
+
+---
+
+### Functions
+
+- `settings_help_str`: Return help string about all available Stty attributes and their possible values on the current platform.
+- `settings_help`: Print help message about all available Stty attributes and their possible values on the current platform.
+
+---
+
+## Compatibility
+
+- Requires Python 3.x and a POSIX-like system with the `termios` module.
+- Some features depend on platform support (e.g., window size).
+
+---
+
+## License
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+---
+
+## Author
+
+Soumendra Ganguly, 2025
+
+---
+
+## See Also
+
+- [stty(1) manpage](https://man7.org/linux/man-pages/man1/stty.1.html)
+- [Python termios documentation](https://docs.python.org/3/library/termios.html)

stty-0.0.1/README.md

@@ -0,0 +1,302 @@
+# stty.py
+
+A Python library for manipulating terminal settings in the style of POSIX `stty(1)`.
+
+---
+
+## Overview
+
+`stty` provides a high-level, Pythonic interface to terminal I/O settings, including control characters, baud rates, and window size, using the `termios` and related modules. It allows you to get, set, save, and restore terminal attributes, and to apply them to file descriptors or pseudo-terminals.
+
+---
+
+## Features
+
+- Read and modify terminal attributes (iflag, oflag, cflag, lflag, control characters, speeds, window size)
+- Save and load settings to/from JSON files
+- Apply settings to file descriptors or pseudo-terminals
+- Symbolic and string-based access to all settings
+- Emulates many `stty(1)` features and modes (e.g., raw, evenp, oddp, nl, ek)
+- Cross-platform support (where `termios` is available)
+
+---
+
+## Installation
+
+This is a pure Python library. Place `stty.py` in your project or install via your preferred method.
+
+---
+
+## Examples
+
+### 1. Reading and Printing Terminal Settings
+
+```python
+from stty import Stty
+
+# Open terminal and get current settings from stdin (fd=0)
+tty = Stty(fd=0)
+print(tty)  # Print all settings in a compact form
+```
+
+---
+
+### 2. Setting Individual Attributes
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Turn off echo
+tty.echo = False
+
+# Set erase character to Ctrl-H
+tty.erase = "^H"
+
+# Set input baud rate to 9600
+tty.ispeed = 9600
+
+# Set number of rows in the terminal window (if supported)
+tty.rows = 40
+```
+
+---
+
+### 3. Setting Multiple Attributes at Once
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Set several attributes in one call
+tty.set(
+    echo=False,
+    icanon=False,
+    erase="^H",
+    ispeed=19200,
+    ospeed=19200,
+    rows=30,
+    cols=100
+)
+```
+
+---
+
+### 4. Saving and Loading Settings
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Save current settings to a file
+tty.save("my_tty_settings.json")
+
+# Later, restore settings from the file
+tty2 = Stty(path="my_tty_settings.json")
+tty2.tofd(0)  # Apply to stdin
+```
+
+---
+
+### 5. Using Raw Mode
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+tty.raw()         # Set raw mode
+tty.tofd(0)       # Apply to stdin
+```
+
+---
+
+### 6. Working with Pseudo-terminals
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+m, s, sname = tty.openpty()  # Open a new pty pair and apply settings to slave
+print(f"Master fd: {m}, Slave fd: {s}, Slave name: {sname}")
+```
+
+---
+
+### 7. Setting Control Characters
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+
+# Set interrupt character to Ctrl-C
+tty.intr = "^C"
+
+# Set end-of-file character to Ctrl-D
+tty.eof = "^D"
+
+# Set suspend character to DEL
+tty.susp = "^?"
+```
+
+---
+
+### 8. Querying Settings as a Dictionary
+
+```python
+from stty import Stty
+
+tty = Stty(fd=0)
+settings = tty.get()
+print(settings["echo"])   # True or False
+print(settings["erase"])  # e.g., '^H'
+```
+
+---
+
+### 9. Using Symbolic Constants
+
+```python
+from stty import Stty, cs8, tab0
+
+tty = Stty(fd=0)
+
+# Set character size to 8 bits using symbolic constant
+tty.csize = cs8
+
+# Set tab delay to tab0
+tty.tabdly = tab0
+```
+
+---
+
+### 10. Fork new process with pseudo-terminal
+
+```python
+x = stty.Stty(0)
+x.intr = "^p"
+pid, m, sname  = x.forkpty()
+
+if pid == 0: # Child process
+    with open("out", "w") as f:
+        f.write(str(stty.Stty(0)))
+else: # Parent process
+    print(sname)
+    print("")
+    s = os.open(sname, os.O_RDWR)
+    print("Parent:", stty.Stty(s))
+    os.close(s)
+```
+
+---
+
+## API Reference
+
+### Classes
+
+#### `Stty`
+
+Manipulate terminal settings in the style of `stty(1)`.
+
+**Constructor:**
+```python
+Stty(fd: int = None, path: str = None, **opts)
+```
+- `fd`: File descriptor to read settings from.
+- `path`: Path to JSON file to load settings from.
+- `**opts`: Any supported terminal attribute as a keyword argument.
+
+**Methods:**
+
+- `get() -> dict`
+  Return a dictionary of all current settings.
+
+- `set(**opts)`
+  Set multiple attributes at once.
+
+- `save(path: str = None)`
+  Save settings to a JSON file, or return a deep copy if no path is given.
+
+- `load(path: str)`
+  Load settings from a JSON file.
+
+- `fromfd(fd: int)`
+  Load settings from a file descriptor.
+
+- `tofd(fd: int, when=TCSANOW, apply_termios=True, apply_winsize=True)`
+  Apply settings to a file descriptor.
+
+- `evenp(plus=True)`
+  Set/unset even parity mode.
+
+- `oddp(plus=True)`
+  Set/unset odd parity mode.
+
+- `raw()`
+  Set terminal to raw mode.
+
+- `nl(plus=True)`
+  Set/unset nl combination mode.
+
+- `ek()`
+  Set ek combination mode.
+
+- `openpty(apply_termios=True, apply_winsize=True)`
+  Open a new pseudo-terminal pair and apply settings.
+
+- `forkpty(apply_termios=True, apply_winsize=True)`
+  Fork a new process with a pseudo-terminal and apply settings.
+
+**Attribute Access:**
+
+- All terminal attributes (e.g., `echo`, `icanon`, `erase`, `ispeed`, `rows`, etc.) are accessible as properties.
+- Setting an attribute updates the internal state and validates the value.
+
+---
+
+### Constants
+
+- `TCSANOW`, `TCSADRAIN`, `TCSAFLUSH`: the values accepted by the `when` named argument of `Stty.tofd()`. Compare with `termios.tcsetattr()`.
+- Symbolic constants for masks and values (e.g., `cs8`, `tab0`, etc.) are available as module attributes.
+
+---
+
+### Data
+
+- `settings`: A dictionary describing all available Stty attributes and their possible values on the current platform.
+
+---
+
+### Functions
+
+- `settings_help_str`: Return help string about all available Stty attributes and their possible values on the current platform.
+- `settings_help`: Print help message about all available Stty attributes and their possible values on the current platform.
+
+---
+
+## Compatibility
+
+- Requires Python 3.x and a POSIX-like system with the `termios` module.
+- Some features depend on platform support (e.g., window size).
+
+---
+
+## License
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+---
+
+## Author
+
+Soumendra Ganguly, 2025
+
+---
+
+## See Also
+
+- [stty(1) manpage](https://man7.org/linux/man-pages/man1/stty.1.html)
+- [Python termios documentation](https://docs.python.org/3/library/termios.html)

stty-0.0.1/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+name = "stty"
+version = "0.0.1"
+description = "A Python library for manipulating terminal settings in the style of POSIX `stty(1)`."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+keywords = [
+  "terminal",
+  "tty",
+  "stty",
+  "termios",
+  "winsize",
+  "posix",
+  "terminal-settings",
+  "pseudo-terminal",
+  "pty",
+  "terminal-attributes"
+]
+authors = [{ name = "Soumendra Ganguly", email = "soumendraganguly@gmail.com" }]
+maintainers = [
+  { name = "Soumendra Ganguly", email = "soumendraganguly@gmail.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+
+  "Intended Audience :: Developers",
+  "Topic :: Terminals",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: System :: Operating System",
+
+  "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3 :: Only"
+]
+
+[project.urls]
+Homepage = "https://github.com/8vasu/stty.py"
+Issues = "https://github.com/8vasu/stty.py/issues"

stty-0.0.1/setup.cfg

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

stty-0.0.1/src/__init__.py

@@ -0,0 +1 @@
+from .stty import *