Skip to content

Commit 79198fd

Browse files
committed
README updates
- Update supported versions. - Mention that '0.0.0.0' address listens all IPv4 interfaces, not all interfaces. Fixes robotframework#60.
1 parent 12dab8d commit 79198fd

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.rst

+9-10
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ Supported Python versions
2222
-------------------------
2323

2424
This remote server is implemented with Python_ and supports also Jython_ (JVM),
25-
IronPython_ (.NET) and PyPy_. Remote server version 1.1 and newer support
26-
Python 2.6, 2.7, 3.3, and newer. Remote server 1.0 series supports Python
27-
versions 2.2-2.7.
25+
IronPython_ (.NET) and PyPy_. Remote server version 1.1 supports Python 2.6,
26+
2.7 and 3.3-3.9. Remote server version 1.1.1 supports Python 3.10 and 3.11
27+
as well.
2828

2929
.. _Python: http://python.org
3030
.. _Jython: http://jython.org
@@ -36,9 +36,8 @@ Supported library APIs
3636

3737
Starting from the remote server version 1.1, Robot Framework's `static,
3838
hybrid and dynamic library APIs`__ are all supported. This includes setting
39-
custom name and tags for keywords using the `robot.api.deco.keyword`__
40-
decorator, although the support for tags requires using Robot Framework 3.0.2
41-
or newer. Earlier remote server versions support only the static and hybrid
39+
custom name and tags for keywords using the `robot.api.deco.keyword`__.
40+
Earlier remote server versions support only the static and hybrid
4241
APIs and do not support the keyword decorator at all.
4342

4443
For most parts these APIs work exactly like when using with Robot Framework
@@ -73,7 +72,7 @@ accepts the following configuration parameters when it is initialized:
7372
Argument Default Explanation
7473
===================== ================= ========================================
7574
``library`` Test library instance or module to host. Mandatory argument.
76-
``host`` ``'127.0.0.1'`` Address to listen. Use ``'0.0.0.0'`` to listen to all available interfaces.
75+
``host`` ``'127.0.0.1'`` Address to listen. Use ``'0.0.0.0'`` to listen to all available IPv4 interfaces.
7776
``port`` ``8270`` Port to listen. Use ``0`` to select a free port automatically. Can be given as an integer or as a string. The default port ``8270`` is `registered by IANA`__ for remote server usage.
7877
``port_file`` ``None`` File to write the port that is used. ``None`` (default) means no such file is written.
7978
``allow_stop`` ``'DEPRECATED'`` Deprecated since version 1.1. Use ``allow_remote_stop`` instead.
@@ -248,7 +247,7 @@ Listing keywords and viewing documentation
248247

249248
Using the built-in Libdoc__ tool you can list the keywords available on the server::
250249

251-
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 list
250+
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 list
252251
Count Items In Directory
253252
Stop Remote Server
254253
Strings Should Be Equal
@@ -259,9 +258,9 @@ an output file::
259258

260259
$ python -m robot.libdoc Remote::http://127.0.0.1:8270 MyLibrary.html
261260
/path/to/MyLibrary.html
262-
261+
263262
__ http://robotframework.org/robotframework/#built-in-tools
264-
263+
265264
Example
266265
-------
267266

0 commit comments

Comments
 (0)