PyOPML

Navigation

  • Usage
  • API Documentation

  • PyOPML @ GitHub
  • PyOPML @ PyPI
  • Issue Tracker
  • Changelog

Quick search

PyOPML documentation¶

Welcome! This documentation is about PyOPML, a Python package meant to read, manipulate and write OPML 2.0 files.

pyversion pypiv tests pypil

Prerequisites¶

  • Python 3.6+

Installation¶

From PyPI:

$ pip install pyopml

Locally, after cloning/downloading the repo:

$ pip install .

User’s Guide¶

  • Usage
    • Creating OPML documents
    • Unserializing OPML documents
    • Manipulating OPML documents
      • Getting and setting document’s metadata
      • Adding outlines to the document
      • Getting and setting outline’s data
      • Creating outlines trees
    • Serializing OPML documents
  • API Documentation
    • Classes
      • OpmlDocument
        • OpmlDocument.add_include()
        • OpmlDocument.add_link()
        • OpmlDocument.add_outline()
        • OpmlDocument.add_rss()
        • OpmlDocument.dump()
        • OpmlDocument.dumps()
        • OpmlDocument.load()
        • OpmlDocument.loads()
      • OpmlOutline
        • OpmlOutline.add_include()
        • OpmlOutline.add_link()
        • OpmlOutline.add_outline()
        • OpmlOutline.add_rss()
    • Exceptions
      • OpmlReadError
      • OpmlWriteError
©2021, Epoc.
Fork me on GitHub