Python CoG Kit Coding Guide
From Java CoG Kit
Gregor von Laszewski and George Thiruvathukal
Version: 0.3 and up
THIS DOCUMENT IS UNDER HEAVY CONSTRUCTION.
This document includes basic information about coding conventions and how to add new modules to the CoGShell and CoGScript.
Contents |
Coding Conventions
In case you like to contribute to these modules we have established these simple coding guidelines.
Editing
Editing is done with eclipse.
we use py???
4 characters as indentation, which is the default setting after download from py ???
Versioning
Version Numbers
The version number for a release is based on an odd even umber scheme. Odd numbers represent development releases, and even numbers represent release versions. Minor numbers represent improvements to the apropiate version.
At this time we have not released any version, but we are starting to develop the third pre-release version. The exact version number will be documented in a file called VERSION.txt in the main directory of the code.
Changes
In the file CHANGES.txt we report on the changes to the module. A major Change should be recored in the CHNGES.txt file.
The format is
mm/dd/yyyy comment about the change
The CHNGES.txt file must be formated in such a way that no line is longer than 79 characters.
Directory names
Directory names must ...
Python Conventions
http://www.python.org/dev/peps/pep-0008/
One-Liners
Logging
Testing
Internationalization
At this time we are not worying about internationalization.
Library Dependencies
Logging
We use the following conventions for using the log4j calls.
Build
Obtaining 3rd party libraries
python setup.py ...
Build
python setup.py ...
Install
python setup.py ...
