taurus taurus

Table Of Contents

Previous topic

Tau to Taurus migration guide

Next topic

Taurus color guide

This Page

Taurus development guidelines

Overview

This document describes taurus from the perspective of developers. Most importantly, it gives information for people who want to contribute to the development of taurus. So if you want to help out, read on!

How to contribute to taurus

Taurus development is done using SVN. Because taurus is part of Tango, it uses its tango-cs sourceforge project to host the source code. This makes it easy for people to contribute to the development of taurus.

How to checkout taurus from SVN

For read-only:

svn co https://tango-cs.svn.sourceforge.net/svnroot/tango-cs/taurus/trunk taurus

To being able to commit:

svn co https://<user name>@tango-cs.svn.sourceforge.net/svnroot/tango-cs/taurus/trunk taurus

Note

You must have a sourceforge user account and have SVN write access to the tango-cs project. You can ask write access to any of the tango-cs project administrators.

Documentation

All standalone documentation should be written in plain text (.rst) files using reStructuredText for markup and formatting. All such documentation should be placed in directory docs/source of the taurus source tree. The documentation in this location will serve as the main source for taurus documentation and all existing documentation should be converted to this format.

Coding conventions

  • In general, we try to follow the standard Python style conventions as described in Style Guide for Python Code

  • Code must be python 2.6 compatible

  • Use 4 spaces for indentation

  • In the same file, different classes should be separated by 2 lines

  • use lowercase for module names. If possible prefix module names with the word taurus (like taurusutil.py) to avoid import mistakes.

  • use CamelCase for class names

  • python module first line should be:

    #!/usr/bin/env python
    
  • python module should contain license information (see template below)

  • avoid poluting namespace by making private definitions private (__ prefix) or/and implementing __all__ (see template below)

  • whenever a python module can be executed from the command line, it should contain a main function and a call to it in a if __name__ == "__main__" like statement (see template below)

  • document all code using Sphinx extension to reStructuredText

The following code can serve as a template for writting new python modules to taurus:

#!/usr/bin/env python

#############################################################################
##
## This file is part of Taurus, a Tango User Interface Library
##
## http://www.tango-controls.org/static/taurus/latest/doc/html/index.html
##
## Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
## Taurus 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.
##
## Taurus 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 Taurus.  If not, see <http://www.gnu.org/licenses/>.
##
#############################################################################

"""A :mod:`taurus` module written for template purposes only"""

__all__ = ["TaurusDemo"]

__docformat__ = "restructuredtext"

class TaurusDemo(object):
    """This class is written for template purposes only"""

def main():
    print "TaurusDemo"

if __name__ == "__main__":
    main()