diff --git a/dist/md2docx_python-0.3.0-py3-none-any.whl b/dist/md2docx_python-0.3.0-py3-none-any.whl new file mode 100644 index 0000000..a9fffae Binary files /dev/null and b/dist/md2docx_python-0.3.0-py3-none-any.whl differ diff --git a/dist/md2docx_python-0.3.0.tar.gz b/dist/md2docx_python-0.3.0.tar.gz new file mode 100644 index 0000000..a346bad Binary files /dev/null and b/dist/md2docx_python-0.3.0.tar.gz differ diff --git a/dist/md2docx_python-python-0.2.0.tar.gz b/dist/md2docx_python-python-0.2.0.tar.gz deleted file mode 100644 index 1b35c00..0000000 Binary files a/dist/md2docx_python-python-0.2.0.tar.gz and /dev/null differ diff --git a/dist/md2docx_python_python-0.2.0-py3-none-any.whl b/dist/md2docx_python_python-0.2.0-py3-none-any.whl deleted file mode 100644 index ee8f82c..0000000 Binary files a/dist/md2docx_python_python-0.2.0-py3-none-any.whl and /dev/null differ diff --git a/md2docx_python.egg-info/PKG-INFO b/md2docx_python.egg-info/PKG-INFO new file mode 100644 index 0000000..9c6aeb3 --- /dev/null +++ b/md2docx_python.egg-info/PKG-INFO @@ -0,0 +1,99 @@ +Metadata-Version: 2.1 +Name: md2docx-python +Version: 0.3.0 +Summary: Markdown to Word Converter. + Simple and straight forward Python utility + that converts a Markdown file (`.md`) to a Microsoft + Word document (`.docx`). It supports basic Markdown + elements, including headings, bold and italic text, + and both unordered and ordered lists. +Home-page: https://github.com/shloktech/md2docx-python +Author: Shlok Tadilkar +Author-email: shloktadilkar@gmail.com +License: MIT +Description: # Markdown to Word Converter + + ## Overview + + Simple and straight forward Python utility that converts a Markdown file (`.md`) to a Microsoft Word document (`.docx`). It supports basic Markdown elements, including headings, bold and italic text, and both unordered and ordered lists. + + #### Input .md file: + ![image](https://github.com/user-attachments/assets/c2325e52-05a7-4e11-8f28-4eeb3d8c06f5) + + #### Output .docx file: + ![image](https://github.com/user-attachments/assets/3e48a9dd-8fe3-43cc-8246-164c58e95179) + + + ## Features + + - Converts Markdown headers (`#`, `##`, `###`) to Word document headings. + - Supports bold and italic text formatting. + - Converts unordered (`*`, `-`) and ordered (`1.`, `2.`) lists. + - Handles paragraphs with mixed content. + + ## Prerequisites + + You need to have Python installed on your system along with the following libraries: + + - `markdown` for converting Markdown to HTML. + - `python-docx` for creating and editing Word documents. + - `beautifulsoup4` for parsing HTML. + + You can install the required libraries using pip: + + ```bash + pip install -r requirements.txt + ``` + + To run the sample files follow the below steps: + + ```bash + python md2docx_python.py + Enter the path to the Markdown file (e.g., README.md): ..\sample_files\amazon_case_study.md + Enter the path for the output Word file (e.g., README.docx): ..\sample_files\amazon_case_study.docx + ``` + + ## Why this repo and not others ? + + Here are some reasons why this repo might be considered better or more suitable for certain use cases compared to other scripts available on the internet: + + ### 1. **Comprehensive Markdown Support** + - **Header Levels**: The script supports multiple header levels (`h1`, `h2`, `h3`), which is important for properly structuring the document. + - **Bold and Italic Text**: It handles bold (`**`) and italic (`*`) text, providing more accurate formatting in the Word document. + + ### 2. **Proper List Formatting** + - **Unordered and Ordered Lists**: The script correctly formats both unordered (`*`, `-`) and ordered lists (`1.`, `2.`) in the Word document. This ensures that lists appear as expected without additional line breaks or formatting issues. + + ### 3. **Use of Well-Supported Libraries** + - **Markdown to HTML Conversion**: Utilizes the `markdown` library, which is a widely used and reliable tool for converting Markdown to HTML. + - **HTML Parsing and Word Document Creation**: Employs `BeautifulSoup` for parsing HTML and `python-docx` for creating Word documents, both of which are robust and well-maintained libraries. + + ### 4. **Simplicity and Readability** + - **Clear Code Structure**: The script is designed to be straightforward and easy to understand, making it accessible for users who may want to customize or extend it. + - **Basic Markdown Elements**: Focuses on the most commonly used Markdown elements, ensuring compatibility with a wide range of Markdown files without unnecessary complexity. + + ### 5. **Customizability** + - **Easy to Modify**: Users can easily adjust the script to handle additional Markdown features or customize the output format based on their specific needs. + - **Example Usage**: Provides a clear example of how to use the script, making it easy for users to adapt it for their own files. + + ### 6. **Minimal Dependencies** + - **Lightweight and Focused**: The script relies on only a few libraries, which reduces potential conflicts and keeps the script lightweight. + + ### 7. **Handles Basic HTML Tags** + - **Text Formatting**: Properly handles bold and italic text by interpreting HTML tags (`strong`, `em`), ensuring that formatting is preserved when converting to Word. + + ### 8. **Privacy** + - If you are working in a corporate firm and you want to convert your markdown files to word and you use a online tool to do it then there are chances that they will store your file which can cause to a vital information leak of your company. With use of this repo you can easily do the conversion in your own system. + + ### Comparison to Other Scripts + - **Feature Set**: Some scripts may lack comprehensive support for Markdown features or may not handle lists and text formatting well. + - **Performance**: Depending on the implementation, performance might vary. This script is designed to be efficient for typical Markdown files. + - **User-Friendliness**: The clear and concise code in this script may make it more user-friendly and easier to modify compared to more complex alternatives. + + Overall, this script provides a balanced combination of functionality, simplicity, and ease of use, which can be advantageous for many users looking to convert Markdown files to Word documents. + + For any queries please start a discussion I will be happy to answer your queries :) + +Platform: UNKNOWN +Requires-Python: >=3.9.0 +Description-Content-Type: text/markdown diff --git a/md2docx_python.egg-info/SOURCES.txt b/md2docx_python.egg-info/SOURCES.txt new file mode 100644 index 0000000..eedc5c4 --- /dev/null +++ b/md2docx_python.egg-info/SOURCES.txt @@ -0,0 +1,9 @@ +setup.py +md2docx_python/__init__.py +md2docx_python.egg-info/PKG-INFO +md2docx_python.egg-info/SOURCES.txt +md2docx_python.egg-info/dependency_links.txt +md2docx_python.egg-info/requires.txt +md2docx_python.egg-info/top_level.txt +md2docx_python/src/__init__.py +md2docx_python/src/md2docx_python.py \ No newline at end of file diff --git a/md2docx_python.egg-info/dependency_links.txt b/md2docx_python.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/md2docx_python.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/md2docx_python.egg-info/requires.txt b/md2docx_python.egg-info/requires.txt new file mode 100644 index 0000000..8346960 --- /dev/null +++ b/md2docx_python.egg-info/requires.txt @@ -0,0 +1,3 @@ +markdown +python-docx +beautifulsoup4 diff --git a/md2docx_python.egg-info/top_level.txt b/md2docx_python.egg-info/top_level.txt new file mode 100644 index 0000000..d204e3c --- /dev/null +++ b/md2docx_python.egg-info/top_level.txt @@ -0,0 +1 @@ +md2docx_python diff --git a/setup.py b/setup.py index 7a146e2..f22372d 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setup( name='md2docx_python', - version='0.2.0', + version='0.3.0', url='https://github.com/shloktech/md2docx-python', author='Shlok Tadilkar', author_email='shloktadilkar@gmail.com',