1. Introduction

Pyro is an acronym for PYthon Remote Objects. It is an advanced and powerful Distributed Object Technology system written entirely in Python, that is designed to be very easy to use. It resembles Java's Remote Method Invocation (RMI). It has less similarity to CORBA - which is a system and language independent Distributed Object Technology and has much more to offer than Pyro or RMI. But Pyro is small, simple, fun and free! For another overview of what Pyro is, see the Pyro page online (http://pyro.sourceforge.net/). You can also download the package from there.

Copyright and Disclaimer
This software is copyright © by Irmen de Jong. It is subject to change without notice. Pyro comes as-is, without warranty and in no event can Irmen de Jong be held liable for any problems resulting from this software. License: Pyro is released under the MIT license, see the file "LICENSE".

Security Warning
In the Security chapter is an important security warning that you absolutely must read!

To get an idea of how Pyro works, here is a scenario:

1. You write a module 'test' containing a class 'testclass', which will be accessed remotely.
2. The server creates one or more instances of the 'testclass', and registers them with the Pyro Name Server.
3. The client queries the Name Server for the location of those objects. It gets a Pyro URI (Universal Resource Identifier) for them.
4. The client creates proxies for the remote objects.
5. Because the proxy mimics the real 'testclass', the client can now invoke methods on the remote objects. The proxy will forward the method invocations and return the results, just as if it was the remote object itself. Not a single line of network communication code has been written.

To dive directly into the code, have a look at the various Pyro examples in the examples directory (read the Readme.txt). There is much to learn there. The easiest example to start with is the "simple" example, it shows how a normal python object is made into a Pyro object and accessed remotely from the client.

Required Software:

• This version of Pyro needs at least Python 2.3. However, it is strongly recommended to use the latest Python version available (at the time of writing 2.4). You may be able to run it on older Python versions (2.1 or 2.2) but it has not been tested on those ancient versions. If it doesn't work, try a recent Python first before reporting a problem. Thank you.
• There is some compatibility with Jython, but no servers are possible, and problems may occur due to Jython bugs.
• Because basic Pyro does not depend on any third party libraries or extension modules, it runs wherever Python is available, however, the command line utility scripts are designed for Windows(NT) and Unix sh. You might experience problems trying to run them on other systems.
• The xnsc tool requires the Tkinter Python extension module, with Tcl/Tk installed.
• The wxnsc tool requires the WxPython extension module with WxWindows.

Important information Links

• Pyro's home page
• Pyro Sourceforge project page
• Pyro Wiki pages, including the online Todo list.
• Info about the Mailing list, which is the best way of getting help.

Related technology

• Java Remote Method Invocation (RMI)
• Common Object Request Broker Architecture (CORBA)
• Fnorb - a CORBA implementation in Python
• The remoting code included in Profigure by Tom Cocagne
• Twisted Spread, part of Twisted.

Thanks

I want to thank everybody on the Pyro mailing list, your participation is of great value. And to everybody who contacted me about Pyro, for positive remarks, comments, or with problems (it all helps to improve Pyro): Thank You!

If you appreciate my efforts and would like to express your appreciation by a cash donation, that is gladly accepted. But because I'm doing Pyro for fun, I've decided to support the PSF by making all donations trough SourceForge go to the Python Software Foundation.