Mercurial > p > roundup > code
diff doc/installation.txt @ 7608:cdc7490f510e
docs: add mention of pyreadline3 under windows
adds support for CLI editing/history under windows.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 17 Aug 2023 13:33:53 -0400 |
| parents | 7515d03fb26d |
| children | 044dea25c1e2 |
line wrap: on
line diff
--- a/doc/installation.txt Thu Aug 17 12:58:37 2023 -0400 +++ b/doc/installation.txt Thu Aug 17 13:33:53 2023 -0400 @@ -284,6 +284,10 @@ You can run Roundup as a Windows service if pywin32_ is installed. Otherwise it must be started manually. +pyreadline3 + When running roundup-admin on windows, installing pyreadline3_ will + allow history and editing on the command line. + requests If you are using OAuth authentication with the roundup-mailgw mail gateway you must install the requests_ library. @@ -2103,6 +2107,17 @@ I do not believe this is possible to do in previous versions of Windows. +Use pip to install pyreadline3 for roundup-admin line editing +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If you install pyreadline3_ using pip, roundup-admin will support +command line editing and history. + +This will remove the dreaded:: + + Note: command history and editing not available + +warning when starting roundup-admin. Windows Server -------------- @@ -2188,7 +2203,6 @@ mod_python instead to serve out Roundup. In that case see the mod_python instructions above for details. - Sendmail smrsh -------------- @@ -2296,6 +2310,7 @@ .. _Psycopg2: https://www.psycopg.org/ .. _pyjwt: https://pypi.org/project/PyJWT/ .. _pyopenssl: https://pypi.org/project/pyOpenSSL/ +.. _pyreadline3: https://pypi.org/project/pyreadline3/ .. _pysqlite: https://pysqlite.org/ .. _pytz: https://pypi.org/project/pytz/ .. _pywin32: https://pypi.org/project/pywin32/
