diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -1,4 +1,4 @@ -Release Log Reader +Release Log Parser ================== Software packages usually include textual files describing noteworthy changes in each subsequent release. There exist several variants (or @@ -87,7 +87,7 @@ Typical usage:: The two mandatory arguments are the format name and the list of lines obtained from the release log file. -Valid format names for this version of ``releaselog`` are: +Valid format names for this version of ``releaselogparser`` are: ``GNU``, ``NEWS`` GNU-style news file. @@ -159,7 +159,7 @@ Example The following simple program reads release log entries from the file ``NEWS`` and prints them on the standard output:: - from releaselog.input import ReleaseLogFile + from releaselogparser.input import ReleaseLogFile for log in ReleaseLogFile('GNU', 'NEWS'): print(log) @@ -193,14 +193,14 @@ the following attributes:: ``None``, if not needed. The file with the definition of the inherited class must be placed in -the directory ``releaselog/format`` reachable from the Python search path +the directory ``releaselogparser/format`` reachable from the Python search path for module files. The following example implements a simplified version of CHANGES.txt log format:: import re - from releaselog import ReleaseHistory + from releaselogparser import ReleaseHistory class ChangesLogFormat(ReleaseHistory): format = ['changes'] |