# JiraWiki2Docx
JiraWiki2Docx is a Python 3 library that converts Jira wiki text to Microsoft Word (docx) format. It provides a convenient way to migrate Jira wiki content to Word documents, allowing users to preserve the formatting and structure of their Jira wiki pages.
## Installation
You can install jirawiki2docx using pip:
```
pip install jirawiki2docx
```
## Usage
To use jirawiki2docx, follow these steps:
1. Import the JiraWiki2Docx class:
```
from jirawiki2docx import JiraWiki2Docx
```
2. Create an instance of the JiraWiki2Docx class, providing the Jira wiki text as input:
```
jira_text = "Your Jira wiki text here..."
converter = JiraWiki2Docx(jira_text)
```
3. Parse the Jira wiki text and generate the Word document:
```
document = converter.parseJira2Docx()
```
4. Optionally, save the resulting document to a file:
```
converter.parseJira2Docx(save_to_file=True, output_filename="output.docx")
```
5. Alternatively, you can use an existing `docx.Document` object and append the converted Jira wiki text to it's content:
```
existing_document = docx.Document()
jira_converter.parseJira2Docx(existing_document)
```
## Example
Here's a complete example that demonstrates the usage of JiraWiki2Docx:
```
from docx import Document
from jirawiki2docx import JiraWiki2Docx
# Jira wiki text
jira_text = """
h1. Heading 1
This is a paragraph.
h2. Heading 2
* Item 1
* Item 2
h3. Heading 3
||Heading 1||Heading 2||
|Cell 1|Cell 2|
This is another paragraph.
"""
# Create a Document object
document = Document()
# Create an instance of JiraWiki2Docx and parse the Jira wiki text
converter = JiraWiki2Docx(jira_text, document)
# Parse Jira markup and convert to Word document with optional arguments to save created/modified document to file or just return as object
converter.parseJira2Docx(save_to_file=True, output_filename="output.docx")
```
The resulting Word document will contain the converted Jira wiki content with appropriate headings, lists, and tables.
## Supported Jira Wiki Syntax
JiraWiki2Docx supports the following Jira wiki syntax:
- Headings (h1 to h6)
- Unordered lists (*, -, #)
- Tables (||)
- Text effects (bold, italics, deleted, inserted, superscript, subscript, and color)
Please note that JiraWiki2Docx may not support all Jira wiki syntax and rendering options.
## License
JiraWiki2Docx is released under the MIT License. See the [LICENSE](https://github.com/deitar/jirawiki2docx/blob/main/LICENSE) file for more details.
## Conclusion
JiraWiki2Docx simplifies the process of converting Jira wiki markup to Word documents. Whether you need to share Jira content with stakeholders or generate printable reports, this library provides an easy-to-use solution. Give it a try and streamline your Jira content management and distribution process.
Raw data
{
"_id": null,
"home_page": "https://github.com/deitar/jirawiki2docx",
"name": "jirawiki2docx",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Ifeoluwa Akande",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3f/9c/d06bdd3a1adfc2bd1f484e27dd018112706ecda1e8c4d1bbbd3b6f063d58/jirawiki2docx-1.0.1.tar.gz",
"platform": null,
"description": "# JiraWiki2Docx\n\nJiraWiki2Docx is a Python 3 library that converts Jira wiki text to Microsoft Word (docx) format. It provides a convenient way to migrate Jira wiki content to Word documents, allowing users to preserve the formatting and structure of their Jira wiki pages.\n\n## Installation\n\nYou can install jirawiki2docx using pip:\n\n```\npip install jirawiki2docx\n``` \n\n## Usage\n\nTo use jirawiki2docx, follow these steps:\n\n1. Import the JiraWiki2Docx class:\n\n\t```\n from jirawiki2docx import JiraWiki2Docx\n ``` \n\n2. Create an instance of the JiraWiki2Docx class, providing the Jira wiki text as input:\n\n\t```\n\tjira_text = \"Your Jira wiki text here...\"\n\tconverter = JiraWiki2Docx(jira_text)\n\t``` \n\n3. Parse the Jira wiki text and generate the Word document:\n\n\t```\n document = converter.parseJira2Docx()\n ```\n\n4. Optionally, save the resulting document to a file:\n\n\t```\n converter.parseJira2Docx(save_to_file=True, output_filename=\"output.docx\")\n ```\n\n5. Alternatively, you can use an existing `docx.Document` object and append the converted Jira wiki text to it's content:\n\n\t```\n\texisting_document = docx.Document()\n\tjira_converter.parseJira2Docx(existing_document)\n\t```\n\n## Example\n\nHere's a complete example that demonstrates the usage of JiraWiki2Docx:\n\n```\nfrom docx import Document\nfrom jirawiki2docx import JiraWiki2Docx\n\n# Jira wiki text\njira_text = \"\"\"\nh1. Heading 1\n\nThis is a paragraph.\n\nh2. Heading 2\n\n* Item 1\n* Item 2\n\nh3. Heading 3\n\n||Heading 1||Heading 2||\n|Cell 1|Cell 2|\n\nThis is another paragraph.\n\"\"\"\n\n# Create a Document object\ndocument = Document()\n\n# Create an instance of JiraWiki2Docx and parse the Jira wiki text\nconverter = JiraWiki2Docx(jira_text, document)\n\n# Parse Jira markup and convert to Word document with optional arguments to save created/modified document to file or just return as object\nconverter.parseJira2Docx(save_to_file=True, output_filename=\"output.docx\")\n```\n\nThe resulting Word document will contain the converted Jira wiki content with appropriate headings, lists, and tables.\n\n## Supported Jira Wiki Syntax\n\nJiraWiki2Docx supports the following Jira wiki syntax:\n\n- Headings (h1 to h6)\n- Unordered lists (*, -, #)\n- Tables (||)\n- Text effects (bold, italics, deleted, inserted, superscript, subscript, and color)\n\nPlease note that JiraWiki2Docx may not support all Jira wiki syntax and rendering options.\n\n## License\n\nJiraWiki2Docx is released under the MIT License. See the [LICENSE](https://github.com/deitar/jirawiki2docx/blob/main/LICENSE) file for more details.\n\n## Conclusion\n\nJiraWiki2Docx simplifies the process of converting Jira wiki markup to Word documents. Whether you need to share Jira content with stakeholders or generate printable reports, this library provides an easy-to-use solution. Give it a try and streamline your Jira content management and distribution process.\n",
"bugtrack_url": null,
"license": "",
"summary": "Convert Jira wiki to DOCX format effectively",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/deitar/jirawiki2docx/issues",
"Homepage": "https://github.com/deitar/jirawiki2docx",
"repository": "https://github.com/deitar/jirawiki2docx"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14948198c1a196cbc4717a61954b38794bd4c88e15f593b69b558dd9fe8ba879",
"md5": "eb06ec8c4fcf037f84649c13c05c24ff",
"sha256": "695d3ab77c8c3db96bac9b39f52eae3a4cc5c15a9cb9c25e45b34006ad44bf31"
},
"downloads": -1,
"filename": "jirawiki2docx-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb06ec8c4fcf037f84649c13c05c24ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 7327,
"upload_time": "2023-07-09T14:09:09",
"upload_time_iso_8601": "2023-07-09T14:09:09.263244Z",
"url": "https://files.pythonhosted.org/packages/14/94/8198c1a196cbc4717a61954b38794bd4c88e15f593b69b558dd9fe8ba879/jirawiki2docx-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f9cd06bdd3a1adfc2bd1f484e27dd018112706ecda1e8c4d1bbbd3b6f063d58",
"md5": "93a00dfe4a9abab0e4faf4594db7c9ae",
"sha256": "30b682f7ddef7d4e58bc6bbb349d76499cff6ba7d63c16f8eb6c98f6b626d489"
},
"downloads": -1,
"filename": "jirawiki2docx-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "93a00dfe4a9abab0e4faf4594db7c9ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6729,
"upload_time": "2023-07-09T14:09:10",
"upload_time_iso_8601": "2023-07-09T14:09:10.527730Z",
"url": "https://files.pythonhosted.org/packages/3f/9c/d06bdd3a1adfc2bd1f484e27dd018112706ecda1e8c4d1bbbd3b6f063d58/jirawiki2docx-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-09 14:09:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deitar",
"github_project": "jirawiki2docx",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "lxml",
"specs": [
[
"==",
"4.9.2"
]
]
},
{
"name": "python-docx",
"specs": [
[
"==",
"0.8.11"
]
]
},
{
"name": "webcolors",
"specs": [
[
"==",
"1.13"
]
]
}
],
"lcname": "jirawiki2docx"
}
JSON
