dls.environment Python Module

1-0

Introduction

This module contains a python object representation of a site enviroment. All other dls python modules use this to get their install instructions, and modules like the dependency_tree use it to find default locations of the production and development areas, etc. It also contains an example application template.

Dependencies

The standard install requires that you have setuptools installed.

Modifying the module for your site

This module is generally only used in installation, and in a few special cases like dls.dependency_tree. However, most users will have to modify and build this in order to build other dls python modules. These are the things that a user will generally have to modify:

It is assumed that the site environment is of a similar structure to dls:

Installation

To make this, or any other dls python module using the dls.environment makefile:

Usage

If you have done a make install, you need to do one of the following:
from pkg_resources import require
require("dls.environment")        # latest installed version 
require("dls.environment==1.0")   # this exact version number   
require("dls.environment>=1.0")   # this version or higher 
If you have done a make test, then you need to set your PYTHONPATH to pick up the right egg: export PYTHONPATH=TEST_INSTALL_DIR Where TEST_INSTALL_DIR is the location you entered in setuptools.mk. You then need to do the require as above

Scripts

The installation process will install the egg into site-packages, and the following scripts to SCRIPT_DIR:

Pydoc

The doxygen documentation is a good starting point, but the Pydoc html pages are included for reference

License

'dls.environment' is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

'dls.environment' is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with 'dls.environment'. If not, see http://www.gnu.org/licenses/.


Generated on Mon Dec 15 08:34:11 2008 for environment by  doxygen 1.5.7.1