opyml/README.md

1.3 KiB

OPyML 🐍

OPML library for Python.

Features

  • Supports all OPML versions.
  • Minimal use of dependencies.
  • 100% typed and tested.

Example

from opyml import OPML, Outline

# Create OPML documents from scratch.
document = OPML()
document.body.outlines.append(Outline(text="Example"))

# Convert documents to XML.
xml = document.to_xml()

# Parse OPML documents from XML.
document = OPML.from_xml(xml)

See also the examples directory.

Development

  • Install dependencies with poetry shell && poetry install.
  • Format code with black opyml tests.
  • Check types with mypy opyml.
  • Run tests and collect coverage with pytest --cov opyml --cov-report html.
  • Generate documentation with pdoc opyml.

Feedback

Found a problem or want to request a new feature? Email helllo@holllo.org and I'll see what I can do for you.

License

Distributed under the Apache License 2.0 and MIT licenses, see LICENSE-Apache and LICENSE-MIT for more information.