Skip to main content

A HTML to Kirbytext converter

Project description

Build Status codecov

This is a html to Kirbytext converter for python.

It is currently in heavy development.

Installation

HTML2Kirby is tested and suported from Python 3.4 upwards

Install via pip:

pip install html2kirby

Usage

To use this package, simply import the package and feed it some html:

from html2kirby import HTML2Kirby

formatter = HTML2Kirby()
formatter.feed("""<img src="https://placekitten.com/200/300" alt="kittens are cute" />""")

You can then access the result via .kirbytext attribute:

print(formatter.kirbytext)
# prints (image: https://placekitten.com/200/300 alt: kittesn are cute)

Testing

Make sure you have Pytest installed (pip install pytest). Then just invoke it:

pytest

Supported Markup

As of now, following tags are supported:

  • Simple formatting (<b>, <strong>, <i>, <em>)

  • Headings (<h1>, <h2>, …)

  • Images (<img>)

  • line breaks (<br>)

  • Paragraphs (<p>)

  • Blocks (<pre>, <code>, <blockquote>, <pre><code>)

  • Links (<a>)

  • Horizontal rulers (<hr>)

  • Lists (<ul>, <ol>, <li>)

Passed markup

Markup tags that aren’t implemented are just dropped except for following tags:

  • table

  • tr

  • td

  • th

  • tbody

  • thead

  • strike

  • u

  • abbr

  • del

  • svg

They will just be kept in the Kirbytext which should result in a valid output.

Issues

In python3.4, the unescape doesn’t quite convert all of the html 5 escaped characters such as – (en dash).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

html2kirby-0.1-1.tar.gz (5.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page