mirror of
https://github.com/gryf/wmdocklib.git
synced 2026-01-30 20:35:48 +01:00
1569327 release 1.1 is broken
trying to clean up things. wmdocklib now contains the modules to install. examples all the scripts. only pywmhdmon.py has been tested.
This commit is contained in:
29
README.txt
29
README.txt
@@ -1,20 +1,21 @@
|
||||
[WHAT]
|
||||
pywmdockapps is a small suite of python modules that will help you develop
|
||||
WindowMaker dockapps in python. pywmgeneral.py, the central module of the
|
||||
suite, is mostly a wrapper around the functions from the popular
|
||||
wmgeneral.c, but some new functions are added too.
|
||||
pywmdockapps is the name of an GPL'd project containing one python package
|
||||
(wmdocklib) and a few python scripts. wmdocklib will help you develop
|
||||
WindowMaker dockapps in python. it is mostly a wrapper around the popular
|
||||
wmgeneral.c, but some new functions have been added too.
|
||||
|
||||
the suite also contains the Python written module pywmhelpers.py which
|
||||
contains functions to aid the development of wm dockapps. This module
|
||||
contains python functions that wrap up the functions which the extension
|
||||
module provides. They ease up argument passing and give nicer return
|
||||
values. Some additional functions, like help for handling a simple
|
||||
configuration file is also available. This module is better documented than
|
||||
the pywmgeneral. It is adviced to only use pywmhelpers and not touch the
|
||||
pywmgeneral module directly at all. For information about how to use the
|
||||
module, see the documentation in pywmhelpers.py. It is also possible to
|
||||
import it in the interactive interpreter and issue 'help(pywmhelpers)'.
|
||||
wmdocklib is divided in two parts: a thin wrapper around the popular
|
||||
wmgeneral.c and a thicker pywmhelpers.py module providing more pythonic
|
||||
interface to the wmdocklib and a few additional functions (e.g.: handling
|
||||
simple configuration files). all functions provided by these modules are
|
||||
imported in the namespace of wmdocklib so you won't need explicit importing
|
||||
of either modules: just import wmdocklib. It is adviced to only use those
|
||||
functions provided by pywmhelpers and not touch the pywmgeneral module
|
||||
directly at all. For information about how to use the module, see the
|
||||
documentation in pywmhelpers.py. It is also possible to import it in the
|
||||
interactive interpreter and issue 'help(pywmhelpers)'.
|
||||
|
||||
the sample scripts are described in the examples/README
|
||||
a small set of samples are provided. all of them make use of the module
|
||||
pywmgeneral.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user