OPML library for Python. https://pypi.org/project/opyml/
Go to file
Bauke 3d102b22a2
Add readme and repository fields
2021-10-25 16:01:58 +02:00
opyml Add readme and repository fields 2021-10-25 16:01:58 +02:00
tests Initial commit! 🌠 2021-10-25 14:54:11 +02:00
.gitignore Initial commit! 🌠 2021-10-25 14:54:11 +02:00
LICENSE-Apache Initial commit! 🌠 2021-10-25 14:54:11 +02:00
LICENSE-MIT Initial commit! 🌠 2021-10-25 14:54:11 +02:00
README.md Initial commit! 🌠 2021-10-25 14:54:11 +02:00
poetry.lock Initial commit! 🌠 2021-10-25 14:54:11 +02:00
pyproject.toml Add readme and repository fields 2021-10-25 16:01:58 +02:00

README.md

opyml

An OPML library for Python.

This is a largely identical "port" of the Rust crate.

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)

For complete examples check out the tests/ directory.

Development

  • Install dependencies with Poetry (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.

License

Dual-licensed with the Apache License, Version 2.0 and MIT license.