Skip to main content

A sample Python project to convert HTML to JIRA Wiki

Project description

Build Status Codacy Badge

Installation

pip install html2jirawiki

Usage

Convert some HTML to Markdown:

    from html2jirawiki import html_to_jira_wiki
    html_to_jira_wiki('<b>Yay</b> <a href="http://github.com">GitHub</a>')  # > '**Yay** [GitHub](http://github.com)'

Specify tags to exclude (blacklist):


    from html2jirawiki import html_to_jira_wiki
    html_to_jira_wiki('<b>Yay</b> <a href="http://github.com">GitHub</a>', strip=['a'])  # > '*Yay* GitHub'

or specify the tags you want to include (whitelist):


    from html2jirawiki import html_to_jira_wiki
    html_to_jira_wiki('<b>Yay</b> <a href="http://github.com">GitHub</a>', convert=['b'])  # > '*Yay* GitHub'

Options

html2jirawiki supports the following options:

strip A list of tags to strip (blacklist). This option can't be used with the convert option.

convert A list of tags to convert (whitelist). This option can't be used with the strip option.

autolinks A boolean indicating whether the "automatic link" style should be used when a a tag's contents match its href. Defaults to True

heading_style Defines how headings should be converted. Accepted values are ATX, ATX_CLOSED, SETEXT, and UNDERLINED (which is an alias for SETEXT). Defaults to UNDERLINED.

bullets An iterable (string, list, or tuple) of bullet styles to be used. If the iterable only contains one item, it will be used regardless of how deeply lists are nested. Otherwise, the bullet will alternate based on nesting level. Defaults to '*+-'.

Options may be specified as kwargs to the html2jirawiki function, or as a nested Options class in MarkdownConverter subclasses.

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

html2jirawiki-1.0.0.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

html2jirawiki-1.0.0-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file html2jirawiki-1.0.0.tar.gz.

File metadata

File hashes

Hashes for html2jirawiki-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f40adf1973ec926eec2b77fb875d11f42317a50cd190df75c6e821345cbd2fbe
MD5 1cce02cde7379fc1afdfeeef491b14a4
BLAKE2b-256 9d911d8537cf411044559104e2428eade97a42d1505bec24d35bd761b9c7ab74

See more details on using hashes here.

File details

Details for the file html2jirawiki-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for html2jirawiki-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 97d441fcf7e74ea5a6042440c8f866a93697b01f5a6f630e6ed882e3f7bcd0aa
MD5 34a89a7b7cd43312dc39d398c29d5ed1
BLAKE2b-256 7967b01fa4c3e432c9ed347c77d67e678054f052ff87f0618e925128a1ac54b0

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