Skip to main content

mistune-jira

A Jira Rendering Engine for Mistune.

Mistune is awesome. It does an amazing job of parsing markdown. It has the ability to take those documents and export them in different sytaxes. This is an attempt to write a parser for Atlassian's Markup Language used in Jira and some other tools.

The goal is to be able to have data in markdown and then use that markdown to create a well formatted ticket in Jira.

Hopefully Jira will someday fully support markdown and make this project irrelevant.

Usage

import mistune
import mistune_jira

text = '''
# Lorem Ipsum

This is some sample markdown. [Say hi to google](https://www.google.com) as an example link
to be converted. 

HR line 
---

* a list of cool things
* doggies
    * Little Doggies (Won't yet render correctly)
    * Shaggy Doggies
    * Grumpy Doggies
* spaceships
* $2 bills

'''

rend = mistune_jira.JiraRenderer()

markdown_parser = mistune.Markdown(renderer=rend)

jira_compat = markdown_parser(text)

print(jira_compat)

Release files for mistune-jira 2023.12.6.0

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

Source distribution (sdist)

Source distribution for mistune-jira 2023.12.6.0
File Size Uploaded
mistune_jira-2023.12.6.0.tar.gz 4.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mistune-jira 2023.12.6.0
File Interpreter ABI Platform
mistune_jira-2023.12.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.5 kB

Release files / mistune_jira-2023.12.6.0.tar.gz

Download URL mistune_jira-2023.12.6.0.tar.gz
Size 4.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1a539ed1be93bd7b3e1470560465d3fb9f02e0ec4af414beb613f06da7923221
BLAKE2b-256 checksum
How to use checksums
0efa05088194dd4acf967e953a6aa372cd9e19c496361557e5f76bdbcbbd3a52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / mistune_jira-2023.12.6.0-py3-none-any.whl

Download URL mistune_jira-2023.12.6.0-py3-none-any.whl
Size 4.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1fa98b540bde6c5a73a8b75d7a8b7fb19ada541edd76781bf73797a4c221022a
BLAKE2b-256 checksum
How to use checksums
486840f8ef0aa3e8a96a3a432b39fa4ed735106d8e7f78b451c5da1bacb51088
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release history Release notifications | RSS feed

This release

2023.12.6.0 This release

2 release files

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