Skip to main content

A mostly functional plugin for mistune to render Jira's markup language

Project description

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)

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

mistune_jira-2023.12.6.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

mistune_jira-2023.12.6.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file mistune_jira-2023.12.6.0.tar.gz.

File metadata

  • Download URL: mistune_jira-2023.12.6.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for mistune_jira-2023.12.6.0.tar.gz
Algorithm Hash digest
SHA256 1a539ed1be93bd7b3e1470560465d3fb9f02e0ec4af414beb613f06da7923221
MD5 ab111615fa66e7bc409ab5861a39ba27
BLAKE2b-256 0efa05088194dd4acf967e953a6aa372cd9e19c496361557e5f76bdbcbbd3a52

See more details on using hashes here.

File details

Details for the file mistune_jira-2023.12.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mistune_jira-2023.12.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1fa98b540bde6c5a73a8b75d7a8b7fb19ada541edd76781bf73797a4c221022a
MD5 a75d1556173fefe30d4dc5c140fd94de
BLAKE2b-256 486840f8ef0aa3e8a96a3a432b39fa4ed735106d8e7f78b451c5da1bacb51088

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