Lightweight OPML parsing.
|Date:||2007-03-20 08:30:21 -0700 (Tue, 20 Mar 2007)|
|Author:||Nathan R. Yergler <email@example.com>|
|Copyright:||2008, Nathan R. Yergler, Creative Commons; licensed to the public under the MIT license.|
opml provides simple support for reading OPML files. OPML is an XML-based format for describing outlines and is often used as an interchange format for subscription lists. This package is intended as a light-weight, permissive parser. It does very little validation of the incoming OPML.
The Python OPML package and its dependencies may be installed using easy_install (recommended)
$ easy_install opml
or by using the standard distutils setup.py:
$ python setup.py install
If installing using setup.py, lxml will also need to be installed. easy_install will manage this for you.
This document is intended to provide a set of literate tests for the opml package; it is not intended to provide thorough coverage of the OPML specification or semantics. See the OPML 2 Specification for details on OPML.
opml can parse OPML from a URI or from a local string. For example, to parse an example from the OPML validator:
>>> import opml >>> outline = opml.parse( ... 'http://hosting.opml.org/dave/validatorTests/clean/subscriptionList.opml')
Elements in the OPML header can be accessed as attributes:
>>> outline.title 'mySubscriptions.opml' >>> outline.ownerName 'Dave Winer' >>> outline.ownerEmail 'firstname.lastname@example.org'
Items in an OPML outline are stored in <outline> elements; these are accessible via the standard Python sequence operators:
>>> len(outline) 13 >>> outline <opml.OutlineElement object at ...>
An OutlineElement object exposes the attributes associated with the element as properties:
>>> outline.text 'CNET News.com' >>> outline.type 'rss'
outline elements may contain other outline elements:
>>> len(outline) 0
When parsing a feed with nested items, the sub-items are accessible using the standard Python sequence operators:
>>> nested = \ ... opml.parse('http://hosting.opml.org/dave/spec/placesLived.opml') >>> len(nested) 6 >>> nested.text 'Boston' >>> len(nested) 2 >>> nested.text 'Cambridge'
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.