https://github.com/vmj/slacklog

Convert Slackware ChangeLog to various formats
https://github.com/vmj/slacklog

changelog feed generator python slackware

Last synced: about 10 hours ago
JSON representation

Convert Slackware ChangeLog to various formats

• Host: GitHub
• URL: https://github.com/vmj/slacklog
• Owner: vmj
• License: gpl-3.0
• Created: 2011-01-27T00:22:48.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2019-03-15T19:08:35.000Z (over 5 years ago)
• Last Synced: 2024-11-02T12:07:05.246Z (15 days ago)
• Topics: changelog, feed, generator, python, slackware
• Language: Python
• Homepage: http://pypi.python.org/pypi/slacklog
• Size: 5.09 MB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
.. image:: https://img.shields.io/pypi/v/slacklog.svg?style=plastic

   :target: https://pypi.python.org/pypi/slacklog

   :alt: Download

.. image:: https://travis-ci.org/vmj/slacklog.svg?branch=master

   :target: https://travis-ci.org/vmj/slacklog

   :alt: Build Status

.. image:: https://readthedocs.org/projects/slacklog/badge/?version=latest

   :target: https://slacklog.readthedocs.io/en/latest/?badge=latest

   :alt: Docs

slacklog -- Convert Slackware Changelog to various formats

**********************************************************

slacklog provides programs and a library to convert a Slackware

ChangeLogs into other formats.  Currently, RSS, Atom, JSON, and PyBlosxom

formats are supported.

| Download: https://pypi.python.org/pypi/slacklog

| Source code: https://github.com/vmj/slacklog

| Builds status: https://travis-ci.org/vmj/slacklog

| Documentation: https://slacklog.readthedocs.org

.. contents::

Basic usage

===========

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 "[email protected] (Mikko Värri)" \

                   --webMaster "[email protected] (Mikko Värri)"

The included Python library provides the ability to make custom

formats easily::

    #!/usr/bin/env python

    from __future__ import print_function

    import codecs

    import locale

    from slacklog.parsers import SlackLogParser

    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 = SlackLogParser().parse(read('ChangeLog.txt'))

    # Just an example of walking the log tree and print it out

    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 expects to

be given Unicode input and formatters generate Unicode data.

Requirements

============

In addition to Python, `python-dateutil

`_ is required.

Python versions 2.7 and 3.4 - 3.7 are tested, together with python-dateutil versions 2.1 - 2.8.

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)

`_ or, if you want the

unreleased version, from `Github `_

git repository.

Trying it in Docker

===================

Here's one way to hack on this inside a container::

    $ docker run --rm -it -v $(pwd):/slacklog -w /slacklog python:3.7-alpine3.8 sh

    # apk add --no-cache curl

    # pip install python-dateutil==2.7.3

    # python setup.py install

    # sh examples/fetch-changelogs.sh

    # sh examples/update-slacklog-rss.sh

Obviously, you need Docker installed and working,

and I'm assuming you run those commands in the git clone.

Authors

=======

Original author and current maintainer is Mikko Värri

([email protected]).

License

=======

slacklog is Free Software, licensed under GNU General Public License

(GPL), version 3 or later.  See LICENSE.txt file for details.