Convert text from JIRA markup to Markdown using parsing expression grammars
Project description
jira2markdown
jira2markdown
is a text converter from JIRA markup to YouTrack Markdown using parsing expression grammars. The Markdown implementation in YouTrack follows the CommonMark specification with extensions. Thus, jira2markdown
can be used to convert text to any Markdown syntax with minimal modifications.
Prerequisites
- Python 3.6+
Installation
pip install jira2markdown
Usage
from jira2markdown import convert
convert("Some *Jira text* formatting [example|https://example.com].")
# >>> Some **Jira text** formatting [example](https://example.com).
# To convert user mentions provide a mapping Jira internal account id to username
# as a second argument to convert function
convert("[Winston Smith|~accountid:internal-id] woke up with the word 'Shakespeare' on his lips", {
"internal-id": "winston",
})
# >>> @winston woke up with the word 'Shakespeare' on his lips
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
jira2markdown-0.1.5.tar.gz
(6.4 kB
view hashes)
Built Distribution
Close
Hashes for jira2markdown-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83976c83de61dafad22aed91859d0ff2355d9d0d76efe0e157dcea8ade6d4d73 |
|
MD5 | 09f0df2fbf2772b51b3b6097d0bc6b70 |
|
BLAKE2b-256 | 42722c066b86d1d4379a68feaa29c13ec1c9e94aecd311dfecf489a12cbed6ff |