X-Git-Url: http://dolda2000.com/gitweb/?a=blobdiff_plain;f=pdm%2F__init__.py;h=537a31e97d79e689c74db0dcb4fb0209d4084403;hb=HEAD;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=7f97a47e579701c8e033ad73259434777f70ef3e;p=pdm.git

diff --git a/pdm/__init__.py b/pdm/__init__.py
index e69de29..537a31e 100644
--- a/pdm/__init__.py
+++ b/pdm/__init__.py
@@ -0,0 +1,31 @@
+"""Python Daemon Management
+
+This package aids in inspecting and managing daemon processes. A
+program intended for running as a daemon may create PDM listeners, to
+which PDM clients may connect in order to interact with the
+process.
+
+This package contains the following modules:
+
+ - srv -- Server module
+ - cli -- Client module
+ - perf -- Library for implementing objects for the PERF protocol
+
+The protocol allows multiple management subprotocols for different
+modes of operation. Currently, the following two management protocols
+are supported.
+
+ - The REPL protocol implements a simple read-eval-print loop which
+   accepts arbitrary Python code, executes it in the daemon process,
+   and returns its replies, all in text form. The protocol is simple,
+   generic, and has few failure modes, but is hardly suitable for
+   programmatic interaction. See the documentation for L{pdm.srv.repl}
+   and L{pdm.cli.replclient} for further details.
+
+ - The PERF protocol is intended for programmatic interaction with the
+   daemon process. Various Python modules may expose objects that
+   implement one or several of a few pre-defined interfaces that allow
+   for various forms of inspection and management of the program
+   state. See the documentation for L{pdm.srv.perf} and
+   L{pdm.cli.perfclient} for further details.
+"""