Skip to content

Commit a054d1b

Browse files
committed
don't require PyYAML in [extras], and document it
1 parent 8f9cc3d commit a054d1b

2 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,14 @@ program.
7777
Fingerprinting Server
7878
---------------------
7979

80-
A built-in fingerprinting server shell is provided to uniquely identify telnet clients::
80+
A built-in fingerprinting server shell is provided to uniquely identify telnet clients.
81+
82+
Install with optional dependencies for full fingerprinting support (prettytable_
83+
and ucs-detect_)::
84+
85+
pip install telnetlib3[extras]
86+
87+
Usage::
8188

8289
export TELNETLIB3_DATA_DIR=./data
8390
telnetlib3-server --shell telnetlib3.fingerprinting_server_shell
@@ -99,6 +106,7 @@ runs it to probe terminal capabilities (colors, sixel, kitty graphics, etc.) and
99106
adds the results to the fingerprint data as ``terminal-fingerprint-data``.
100107

101108
.. _ucs-detect: https://github.com/jquast/ucs-detect
109+
.. _prettytable: https://pypi.org/project/prettytable/
102110

103111
Legacy telnetlib
104112
----------------

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ docs = [
5353
extras = [
5454
"ucs-detect>=2",
5555
"prettytable",
56-
"pyyaml",
5756
]
5857

5958
[project.scripts]

0 commit comments

Comments
 (0)