diff options
Diffstat (limited to 'releaselogparser/format/__init__.py')
-rw-r--r-- | releaselogparser/format/__init__.py | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/releaselogparser/format/__init__.py b/releaselogparser/format/__init__.py new file mode 100644 index 0000000..a5e8ea0 --- /dev/null +++ b/releaselogparser/format/__init__.py @@ -0,0 +1,21 @@ +""" +Release History Format implementations + +To implement a new format, drop into this directory a python source defining +a subclass of ReleaseHistory with the new implementation. The name for the +new format must be defined in the 'format' subclass attribute. This attribute +can be either a string or a list of strings. Use the latter form to define +aliases. + +The name of the file normally used to keep release history in this format +must be stored in the 'filename' attribute. + +For example + + class NewHistoryFormat(ReleaseHistory): + format = 'newformat' + filename = 'HISTORY.txt' + ... + +See the ReleaseHistory documentation for details. +""" |