| Name | mistune-jira JSON |
| Version |
2023.12.6.0
JSON |
| download |
| home_page | |
| Summary | A mostly functional plugin for mistune to render Jira's markup language |
| upload_time | 2023-12-06 19:10:48 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | BSD-3-Clause |
| keywords |
mistune
jira
atlassian
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mistune-jira
A Jira Rendering Engine for Mistune.
[Mistune](https://github.com/lepture/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](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all).
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
```python
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)
```
Raw data
{
"_id": null,
"home_page": "",
"name": "mistune-jira",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "mistune,jira,atlassian",
"author": "",
"author_email": "Chris Halbersma <chris@halbersma.us>",
"download_url": "https://files.pythonhosted.org/packages/0e/fa/05088194dd4acf967e953a6aa372cd9e19c496361557e5f76bdbcbbd3a52/mistune_jira-2023.12.6.0.tar.gz",
"platform": null,
"description": "# mistune-jira\n\nA Jira Rendering Engine for Mistune. \n\n[Mistune](https://github.com/lepture/mistune) is awesome. It does an amazing job of parsing\nmarkdown. It has the ability to take those documents and export them in different sytaxes.\nThis is an attempt to write a parser for \n[Atlassian's Markup Language used in Jira and some other tools](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all).\n\nThe goal is to be able to have data in markdown and then use that markdown to create a well formatted\nticket in Jira. \n\nHopefully Jira will someday fully support markdown and make this project irrelevant.\n\n## Usage\n\n```python\nimport mistune\nimport mistune_jira\n\ntext = '''\n# Lorem Ipsum\n\nThis is some sample markdown. [Say hi to google](https://www.google.com) as an example link\nto be converted. \n\nHR line \n---\n\n* a list of cool things\n* doggies\n * Little Doggies (Won't yet render correctly)\n * Shaggy Doggies\n * Grumpy Doggies\n* spaceships\n* $2 bills\n\n'''\n\nrend = mistune_jira.JiraRenderer()\n\nmarkdown_parser = mistune.Markdown(renderer=rend)\n\njira_compat = markdown_parser(text)\n\nprint(jira_compat)\n```\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A mostly functional plugin for mistune to render Jira's markup language",
"version": "2023.12.6.0",
"project_urls": null,
"split_keywords": [
"mistune",
"jira",
"atlassian"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "486840f8ef0aa3e8a96a3a432b39fa4ed735106d8e7f78b451c5da1bacb51088",
"md5": "a75d1556173fefe30d4dc5c140fd94de",
"sha256": "1fa98b540bde6c5a73a8b75d7a8b7fb19ada541edd76781bf73797a4c221022a"
},
"downloads": -1,
"filename": "mistune_jira-2023.12.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a75d1556173fefe30d4dc5c140fd94de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4513,
"upload_time": "2023-12-06T19:10:46",
"upload_time_iso_8601": "2023-12-06T19:10:46.921714Z",
"url": "https://files.pythonhosted.org/packages/48/68/40f8ef0aa3e8a96a3a432b39fa4ed735106d8e7f78b451c5da1bacb51088/mistune_jira-2023.12.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0efa05088194dd4acf967e953a6aa372cd9e19c496361557e5f76bdbcbbd3a52",
"md5": "ab111615fa66e7bc409ab5861a39ba27",
"sha256": "1a539ed1be93bd7b3e1470560465d3fb9f02e0ec4af414beb613f06da7923221"
},
"downloads": -1,
"filename": "mistune_jira-2023.12.6.0.tar.gz",
"has_sig": false,
"md5_digest": "ab111615fa66e7bc409ab5861a39ba27",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4035,
"upload_time": "2023-12-06T19:10:48",
"upload_time_iso_8601": "2023-12-06T19:10:48.509795Z",
"url": "https://files.pythonhosted.org/packages/0e/fa/05088194dd4acf967e953a6aa372cd9e19c496361557e5f76bdbcbbd3a52/mistune_jira-2023.12.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 19:10:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mistune-jira"
}
