Richard Gruet, Rev 1 May 28, 2003
 

 

Overview
List of modules in this package
List of scripts in this package
Requirements
Installation
Documentation
License

Overview

The Python package rgutils is a bundle of miscellaneous utility modules. However many modules are actually independent, so you can extract them from the package and use them separately if you wish.

All modules are provided as-is. Some of them are really simple, not to say simplistic (eg. pool, env). Other ones are more elaborated (getargs, process, proxy). Actually I include new modules in rgutils everytime I happen to write a module that looks (to me) of general interest.

List of modules in the package

Module	Description
async	Asynchronous utilities (timed out function call).
dataxfer	Functions for transfering arbitrary sized data in a distributed (client/server) environment via a FTP server.
env	PATH environnement variable utilities.
getargs	Yet another Command line arguments parser.
glock	This module defines the class GlobalLock that implements a global (inter-process) mutex that works on Windows and Unix, using file-locking on Unix (I also tried this approach on Windows but got some tricky problems so I ended using a Win32 Mutex).
imap	Utilities for reading IMAP mail. Uses message.
message	Defines 2 classes used by the modules pop3 and imap.
pool	Resource pool management.
pop3	Utilities for reading POP3 mail. Uses message.
process	Simple process management on Windows and Unix.
proxy	Object Proxies.
templates	Simple template management..
trace	Misc trace/log & error management functions.

List of scripts in the package

A few scripts are also included with rgutils. They will be installed under <prefix>\Scripts on Windows, and <prefix>/lib/pythonx.y/scripts on Unix. prefix will be typically your Python install directory on Windows, and /usr on Unix. It is convenient to add this directory to your PATH if it is not already the case, so you can launch the scripts from anywhere by simply typing "script.py" (or even "script" on Windows, if the environment variable PATHEXT includes the extension .py).

Note: On Linux, you may have to chmod +x the Python scripts before being able to execute them.

Script	Description
fwdmail.py	Forward mail (POP3 and IMAP4) and optionally remove it.
pdflist.py	Creates PDF listings of python source programs with syntax highlighting. Use py2pdf.
py2pdf.py	Dinu C. Gherman's Python highlighter for PDF. Uses the ReportLab toolkit version >=0.92 to generate PDF (not included here, you can get it for free here).

Requirements

• Python 1.5.2 to 2.2, depending on the module.

Installation

On windows

Download the executable installer rgutils-1.0.3.win32.exe and execute it.

The files will be installed under <prefix>/Lib/site-packages/rgutils (<prefix> being your Python home directory).
You may uninstall the package later via Control panel Add/Remove programs.

On Linux

Download the binary RPM rgutils-1.0.3-1.redhat.noarch.rpm and install it by executing :
    rpm -ivh rgutils-1.0.3-1.redhat.noarch.rpm

The files will be installed under <prefix>/lib/pythonx.y/site-packages/rgutils (<prefix> is usually /usr or /usr/local under Linux)

You may uninstall the package later by executing :
    rpm -e rgutils

On other platforms

Uncompress one of the source distributions (rgutils-1.0.3.zip or rgutils-1.0.3.tar.gz) in a temporary directory, then cd to this directory and execute:
    python setup.py install

To uninstall later you will have to remove the files manually. Delete the files under site-packages/rgutils, and don't forget the scripts in the scripts directory!

Documentation

The HTML documentation (in javadoc style) for the package is in the <rgutils-install-dir>/rgutils/doc directory (start with index.html). It is also available online here.

License

(c) Copyright 2000-2003 by Richard Gruet

This software is distributed under the LGPL license.