{"id":9847,"library":"jira2markdown","title":"Jira Markup to Markdown Converter","description":"jira2markdown is a Python library designed to convert text formatted with Jira markup into standard Markdown. It utilizes parsing expression grammars for robust conversion, handling various Jira elements like headings, lists, code blocks, and links. The current version is 0.5, and it maintains an active development cycle with minor releases addressing feature enhancements and bug fixes.","status":"active","version":"0.5","language":"en","source_language":"en","source_url":"https://github.com/catcombo/jira2markdown","tags":["jira","markdown","conversion","parser","markup"],"install":[{"cmd":"pip install jira2markdown","lang":"bash","label":"Install latest version"}],"dependencies":[{"reason":"Core parsing engine for Jira markup conversion.","package":"pyparsing"}],"imports":[{"symbol":"convert","correct":"from jira2markdown import convert"}],"quickstart":{"code":"from jira2markdown import convert\n\njira_text = \"\"\"\nh1. Heading 1\n* List item 1\n** Sub-item 1\n{code:python}\nprint(\"Hello, Jira!\")\n{code}\n[https://example.com|Example Website]\n\"\"\"\n\nmarkdown_text = convert(jira_text)\nprint(markdown_text)","lang":"python","description":"Demonstrates converting a multi-line Jira formatted string containing headings, lists, code blocks, and a link into Markdown."},"warnings":[{"fix":"Upgrade your Python environment to 3.9 or newer, or pin `jira2markdown` to a version less than 0.5 (e.g., `pip install 'jira2markdown<0.5'`) if you must use an older Python version.","message":"Version 0.5 and newer of `jira2markdown` require Python 3.9 or higher. Earlier versions supported Python 3.7+.","severity":"breaking","affected_versions":">=0.5"},{"fix":"Ensure `pyparsing` is installed according to `jira2markdown`'s requirements (`pyparsing>=3.0.0`). If issues arise, try recreating your virtual environment or explicitly installing `pyparsing` to the latest compatible version.","message":"The `pyparsing` dependency has undergone specific version pinning and unpinning in the past (e.g., v0.3.5 pinned to 3.0.9, v0.3.6 unpinned). While the current requirement is `pyparsing>=3.0.0`, users might encounter parsing inconsistencies if they are using an outdated or incompatible `pyparsing` version manually.","severity":"gotcha","affected_versions":">0.3"},{"fix":"Review table rendering in your applications if you're upgrading from a version older than 0.3.7 and convert Jira markup containing tables.","message":"Table header delimiter changed in version 0.3.7 to `---` for compliance with YouTrack Markdown. This might affect how tables are rendered if you relied on a different delimiter in previous versions.","severity":"gotcha","affected_versions":">0.3.6"},{"fix":"Verify the output for images with attributes when upgrading from versions prior to 0.4, as their rendering might have changed.","message":"Version 0.4 introduced changes to image rendering, specifically to handle images with properties using a YouTrack-like Markdown format.","severity":"gotcha","affected_versions":">0.3.7"}],"env_vars":null,"last_verified":"2026-04-17T00:00:00.000Z","next_check":"2026-07-16T00:00:00.000Z","problems":[{"fix":"Install the library using pip: `pip install jira2markdown`","cause":"The `jira2markdown` library has not been installed in your current Python environment.","error":"ModuleNotFoundError: No module named 'jira2markdown'"},{"fix":"Pass your Jira text as the first argument to the `convert` function, e.g., `markdown_output = convert(\"Your Jira text here\")`.","cause":"The `convert` function was called without providing the required Jira formatted string as an argument.","error":"TypeError: convert() missing 1 required positional argument: 'text'"},{"fix":"Upgrade your Python environment to 3.9 or newer. Alternatively, if you cannot upgrade Python, install an older compatible version of the library: `pip install 'jira2markdown<0.5'`.","cause":"You are attempting to run `jira2markdown` version 0.5 or newer on an unsupported Python version (e.g., Python 3.7 or 3.8).","error":"SyntaxError: future feature annotations is not defined"}]}