Skip to content

Commit 1eb2d64

Browse files
committed
docs: add mention of pyreadline3 under windows
adds support for CLI editing/history under windows.
1 parent e97d941 commit 1eb2d64

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

CHANGES.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Fixed:
4545
- issue2551290 - pip install roundup Hangs on Windows 10
4646
The install under windows goes into an infinite loop using pip or
4747
source install. (John Rouillard)
48+
- Document use of pyreadline3 to allow roundup-admin to have CLI editing
49+
on windows. (John Rouillard)
4850

4951
Features:
5052

doc/installation.txt

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,10 @@ Windows Service
284284
You can run Roundup as a Windows service if pywin32_ is installed.
285285
Otherwise it must be started manually.
286286

287+
pyreadline3
288+
When running roundup-admin on windows, installing pyreadline3_ will
289+
allow history and editing on the command line.
290+
287291
requests
288292
If you are using OAuth authentication with the roundup-mailgw
289293
mail gateway you must install the requests_ library.
@@ -2103,6 +2107,17 @@ Panel" is directly accessible from "Start".
21032107

21042108
I do not believe this is possible to do in previous versions of Windows.
21052109

2110+
Use pip to install pyreadline3 for roundup-admin line editing
2111+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2112+
2113+
If you install pyreadline3_ using pip, roundup-admin will support
2114+
command line editing and history.
2115+
2116+
This will remove the dreaded::
2117+
2118+
Note: command history and editing not available
2119+
2120+
warning when starting roundup-admin.
21062121

21072122
Windows Server
21082123
--------------
@@ -2188,7 +2203,6 @@ If you are using Apache as the webserver you might want to use it with
21882203
mod_python instead to serve out Roundup. In that case see the mod_python
21892204
instructions above for details.
21902205

2191-
21922206
Sendmail smrsh
21932207
--------------
21942208

@@ -2296,6 +2310,7 @@ the test.
22962310
.. _Psycopg2: https://www.psycopg.org/
22972311
.. _pyjwt: https://pypi.org/project/PyJWT/
22982312
.. _pyopenssl: https://pypi.org/project/pyOpenSSL/
2313+
.. _pyreadline3: https://pypi.org/project/pyreadline3/
22992314
.. _pysqlite: https://pysqlite.org/
23002315
.. _pytz: https://pypi.org/project/pytz/
23012316
.. _pywin32: https://pypi.org/project/pywin32/

0 commit comments

Comments
 (0)