Skip to main content

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).

Metadata

Release files for html2kirby 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for html2kirby 0.2
File Size Uploaded
html2kirby-0.2.tar.gz 5.4 kB Details

Release files / html2kirby-0.2.tar.gz

Download URL html2kirby-0.2.tar.gz
Size 5.4 kB
Tags Source
SHA-256 checksum
How to use checksums
482a3d969f6fa65b7c4cb19d2458bac880f84a2962e3043be1501cd550e1f3fb
BLAKE2b-256 checksum
How to use checksums
88c82b5e5f24a51f52d2292c9d182d53d4c1606d8929ca26fdb62b3b6d9a5a30
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2 This release

1 release file

0.1-1

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page