1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
|
.. index:: command line tools
.. _command-line:
******************
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.
- :command:`pyro5-ns` (name server)
- :command:`pyro5-nsc` (name server client tool)
- :command:`pyro5-echoserver` (test echo server)
- :command:`pyro5-check-config` (prints configuration)
- :command:`pyro5-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 :ref:`nameserver-nameserver` and :ref:`nameserver-nsc` for detailed information.
HTTP gateway server:
See :ref:`http-gateway` for detailed information.
.. index::
double: echo server; command line
.. _command-line-echoserver:
Test echo server
================
:command:`python -m Pyro5.utils.echoserver [options]` (or simply: :command:`pyro5-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:
.. program:: Pyro5.utils.echoserver
.. 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:
.. method:: echo(argument)
Simply returns the given argument object again.
.. method:: error()
Generates a run time exception.
.. method:: shutdown()
Terminates the echo server.
.. index::
double: configuration check; command line
Configuration check
===================
:command:`python -m Pyro5.configure` (or simply: :command:`pyro5-check-config`)
This is the equivalent of::
>>> import Pyro5
>>> print(Pyro5.config.dump())
It prints the Pyro version, the location it is imported from, and a dump of the active configuration items.
|