Skip to main content

Convert basic HTML into DraftJS JSON format.

Project description

HTML to DraftJS

Convert HTML into DraftJS JSON format.

Requirement Status Coverage Status Version

Commits since latest release Supported versions Supported implementations

Installation

pip install html-to-draftjs

Usage

from html_to_draftjs import html_to_draftjs


json = html_to_draftjs("""
    <h1>My Page</h1>

    <h2>Introduction</h2>

    <p>Some <em>content</em> that is pretty <strong>interesting</strong></p>
    <p>Don't forget to <a href="https://example.com">follow me!</a></p>

    <h2>Illustration</h2>
    <p><img src="https://example.com/image.png" alt="image" /></p>
""")

API

html_to_draftjs(raw_html_content: str[, features="lxml", strict=False]) -> dict

Converts a given HTML input into JSON.

  • features the features for the HTML tree-builder. By default it is set to lxml which is fast and powerful.
  • strict (boolean), if false, it will only warn on invalid operations. If true, it will raise errors.

soup_to_draftjs(bs_object: BeautifulSoup[, strict=False]) -> dict

Converts a given beautiful soup into JSON. Useful if you have to select a given part of the HTML content to convert it (e.g. #content).

  • strict (boolean), if false, it will only warn on invalid operations. If true, it will raise errors.

Supported Tags and Attributes

Blocks

  • <div>, <p>
  • <h1> ... <h6>
  • <blockquote>
  • <li> and <ol> (doesn't support <ul> grouping)
  • Doesn't support the align attribute.

Inline Styling

  • <strong>, <b>
  • <em>, <i>

Entities

  • <img src="url" [alt="alt"] [height="123"] [width="123"]>
  • <a href="url">
  • <br/>
  • Doesn't support the title and align attributes.

Development

./setup.py develop
pip install -r requirements_dev.txt

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

html-to-draftjs-1.0.1.tar.gz (6.7 kB view details)

Uploaded Source

File details

Details for the file html-to-draftjs-1.0.1.tar.gz.

File metadata

  • Download URL: html-to-draftjs-1.0.1.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.2

File hashes

Hashes for html-to-draftjs-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2212acf3b063c17b6dc91875f474159e1f730c1a4e5fbf74f9a66250f7040e9a
MD5 aa246de1646166e8ff660f895f6f7de3
BLAKE2b-256 840fe6f3d05e4e23fd1e9de9fb84376e65323c8c7a53bbef97ea4e69fbc93ba6

See more details on using hashes here.

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