-------------------------------------------------------------------------------
 streamtuner-python overview
-------------------------------------------------------------------------------

Index

	0. About this document
	1. About streamtuner-python
	2. Usage
	3. Stability
	4. Documentation map

0. About this document

	$Id: README,v 1.7 2004/05/02 18:27:46 jylefort Exp $

	Copyright (c) 2003, 2004 Jean-Yves Lefort.

	This document is part of streamtuner-python. It may be
	distributed under the same terms as streamtuner-python.

1. About streamtuner-python

	streamtuner-python is a streamtuner plugin providing an
	embedded Python interpreter.

	streamtuner is a stream directory browser, available at
	http://www.nongnu.org/streamtuner/.

	Python is an interpreted, interactive, object-oriented
	programming language, available at http://www.python.org/.

	The plugin allows to write a streamtuner handler in Python.
	Scripts will be loaded from LIBDIR/scripts and
	~/.streamtuner/streamtuner-python/scripts. They must have the
	.py extension.

	Three example scripts are shipped with the plugin:

		- basic.ch.py, providing a basic.ch handler
		- google-stations.py, providing a Google Stations handler
		- punkcast.com.py, providing a punkcast.com handler

2. Usage

	The API is not yet documented. If you want to write a script,
	base your work on the provided example scripts. Feel free to
	ask questions to streamtuner-misc@nongnu.org.

	Note that the plugin has only been tested with the 2.3 branch
	of Python. It might not work or even build with previous
	versions of Python.
	
3. Stability

	The implementation performs strict type checking. It is
	theorically impossible to crash streamtuner from a Python
	script.

4. Documentation map

	The following documents are included in the distribution:

		COPYING		licensing information

		README		this document

		INSTALL		installation instructions

		NEWS		reverse chronology of changes,
				manually edited

		ChangeLog	reverse chronology of changes,
				automatically generated from CVS
				commit messages

		TODO		to-do list, mostly useful for developers
