Command line tools

Pyro has several command line tools that you will be using sooner or later. They are generated and installed when you install Pyro.

  • pyro4-ns (name server)
  • pyro4-nsc (name server client tool)
  • pyro4-test-echoserver (test echo server)
  • pyro4-check-config (prints configuration)
  • pyro4-flameserver (flame server)
  • pyro4-httpgateway (http gateway server)

If you prefer, you can also invoke the various “executable modules” inside Pyro directly, by using Python’s “-m” command line argument.

Some of these tools are described in detail in their respective sections of the manual:

Name server tools:
See Starting the Name Server and Name server control tool for detailed information.
HTTP gateway server:
See Pyro via HTTP and JSON for detailed information.

Test echo server

python -m Pyro4.test.echoserver [options] (or simply: pyro4-test-echoserver [options])

This is a simple built-in server that can be used for testing purposes. It launches a Pyro object that has several methods suitable for various tests (see below). Optionally it can also directly launch a name server. This way you can get a simple Pyro server plus name server up with just a few keystrokes.

A short explanation of the available options can be printed with the help option:

-h, --help

Print a short help message and exit.

The echo server object is available by the name test.echoserver. It exposes the following methods:

echo(argument)

Simply returns the given argument object again.

error()

Generates a run time exception.

shutdown()

Terminates the echo server.

Configuration check

python -m Pyro4.configuration (or simply: pyro4-check-config) This is the equivalent of:

>>> import Pyro4
>>> print(Pyro4.config.dump())

It prints the Pyro version, the location it is imported from, and a dump of the active configuration items.