Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,19 @@

.. image:: https://img.shields.io/badge/Linux-yes-success?logo=linux
:alt: Linux supported
:target: https://telnetlib3.readthedocs.io/

.. image:: https://img.shields.io/badge/Windows-yes-success?logo=windows
:alt: Windows supported
:target: https://telnetlib3.readthedocs.io/

.. image:: https://img.shields.io/badge/MacOS-yes-success?logo=apple
:alt: MacOS supported
:target: https://telnetlib3.readthedocs.io/

.. image:: https://img.shields.io/badge/BSD-yes-success?logo=freebsd
:alt: BSD supported
:target: https://telnetlib3.readthedocs.io/

Introduction
============
Expand Down Expand Up @@ -49,17 +53,19 @@ telnetlib3 provides multiple interfaces for working with the Telnet protocol:

**Blocking API**
A synchronous interface modeled after telnetlib (client) and miniboa_ (server),
with enhancements. See the `sync API documentation`_.
with enhancements.

Enhancements over standard telnetlib:
See `sync API documentation`_.

Enhancements over Python 3.11 telnetlib (client):

- Full RFC 854 protocol negotiation (NAWS, TTYPE, BINARY, ECHO, SGA)
- `wait_for()`_ method to block until specific option states are negotiated
- `get_extra_info()`_ for terminal type, size, and other metadata
- Context manager support (``with TelnetConnection(...) as conn:``)
- Thread-safe operation with asyncio_ running in background

Enhancements over miniboa for server-side:
Enhancements over miniboa (server):

- Thread-per-connection model with blocking I/O (vs poll-based)
- `readline()`_ and `read_until()`_ blocking methods
Expand Down
Loading