1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
.. _coding-guide:
==============================
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 <https://sourceforge.net/projects/tango-cs/>`_
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 :file:`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 <http://www.python.org/peps/pep-0008.html>`_
* 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 :file:`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()
.. _Tango: http://www.tango-controls.org/
.. _tango_cs: https://sourceforge.net/projects/tango-cs/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx.pocoo.org/
|
