slacklog 0.0.1

Convert Slackware ChangeLog to RSS

========
slacklog
========

slacklog provides a program and a library to convert a Slackware
ChangeLog into other formats. Currently, RSS is supported. Typical
usage of the program looks like this::

slacklog2rss --changelog slackware-current/ChangeLog.txt \
--encoding iso8859-1 \
--out ~/public_html/slackware-current.rss \
--slackware "Slackware current" \
--rssLink "http://linuxbox.fi/~vmj/slackware-current.rss \
--description "Slackware current activity" \
--managingEditor "[e-mail] (Mikko Värri)" \
--webMaster "[e-mail] (Mikko Värri)"

The included Python library provides the ability to make custom
formats easily::

#!/usr/bin/env python
import codecs
import locale
from slacklog import parsers

def read(file):
'''Return file contents as Unicode.'''
return codecs.open(file, 'r', 'iso8859-1').read()

def write(str):
'''Print out in preferred encoding.'''
print str.encode(locale.getpreferredencoding())

# Parse the ChangeLog
log = parsers.SlackLogParser.parse(read('ChangeLog.txt'))

# Print a custom format
for entry in log.entries:
write(u'[%s] %s\n' % (entry.timestamp.isoformat(), entry.description))
for pkg in entry.pkgs:
write(u'%s:%s' % (pkg.pkg, pkg.description))

Note that slacklog package deals solely in Unicode; parser expect to
be given Unicode input and formatters generate Unicode data.

Requirements
============

In addition to Python, `python-dateutil
<http://pypi.python.org/pypi/python-dateutil>`_ is required.

Installation
============

Use either ``pip install slacklog`` or download the source archive and
use ``python setup.py install``.

The source code is available at `Python Package Index (PyPI)
<http://pypi.python.org/pypi/slacklog>`_ or, if you want the
unreleased version, from `Github <https://github.com/vmj/slacklog>`_
git repository.

Authors
=======

Original author and current maintainer is Mikko Värri
([e-mail]).

License
=======

slacklog is Free Software, licensed under GNU General Public License
(GPL), version 3 or later. See LICENSE.txt file for details.