Quick Start Guide Leave feedback

This guide provides a quick overview of how to set up and start using GroupDocs.Conversion for Python via .NET. This library enables developers to convert between various file formats (e.g., DOCX, PDF, PNG) with minimal configuration.

To proceed, make sure you have:

1. Configured environment as described in the System Requirements topic.
2. Downloaded whl file for your operation system from the official GroupDocs Releases website.
3. Optionally you may Get a Temporary License to test all the product features.

For best practices, use a virtual environment to manage dependencies in Python applications. Learn more about virtual environment at Create and Use Virtual Environments documentation topic.

Create a virtual environment:

py -m venv .venv

python3 -m venv .venv

Activate a virtual environment:

.venv\Scripts\activate

source .venv/bin/activate

After activating the virtual environment, copy the downloaded OS-specific package into your project directory and install it.

py -m pip install groupdocs_conversion_net-24.11-py3-none-win_amd64.whl

py -m pip install groupdocs_conversion_net-24.11-py3-none-win32.whl

python3 -m pip install groupdocs_conversion_net-24.11-py3-none-macosx_11_0_arm64.whl

python3 -m pip install groupdocs_conversion_net-24.11-py3-none-macosx_10_14_x86_64.whl

Ensure the package is installed successfully. You should see the message

Successfully installed groupdocs-conversion-net-24.11

To quickly test the library, let’s convert a DOCX file to PDF. You can also download the app that we’re going to buid here.

import os
from groupdocs.conversion import License, Converter
from groupdocs.conversion.options.convert import PdfConvertOptions

def convert_docx_to_pdf():
    # Get license file absolute path
    license_path = os.path.abspath("./GroupDocs.Conversion.lic")

    if os.path.exists(license_path):
        # Create License and set the path
        license = License()
        license.set_license(license_path)

    # Load DOCX file
    with Converter("./business-plan.docx") as converter:
        # Create convert options
        pdf_convert_options = PdfConvertOptions()

        # Convert DOCX to PDF
        converter.convert("./business-plan.pdf", pdf_convert_options)    

if __name__ == "__main__":
    convert_docx_to_pdf()

Your folder tree should look similar to the following directory structure:

📂 demo-app
 ├──convert_docx_to_pdf.py
 ├──business-plan.docx
 ├──groupdocs_conversion_net-24.11-py3-none-*.whl
 └──GroupDocs.Conversion.lic (Optionally)

py convert_docx_to_pdf.py

python3 convert_docx_to_pdf.py

After running the app you can deactivate virtual environment by executing deactivate or closing your shell.

• Converter("./business-plan.docx"): Initializes the converter with the DOCX file.
• PdfConvertOptions(): Specifies the output format as PDF.
• converter.convert("./business-plan.pdf", pdf_convert_options): Converts the DOCX file to PDF and saves it as business-plan.pdf.

In this example we’ll convert PDF document pages to PNG. You can download the app that we’re going to buid here.

import os
from groupdocs.conversion import License, Converter
from groupdocs.conversion.filetypes import ImageFileType
from groupdocs.conversion.options.convert import ImageConvertOptions

def convert_pdf_pages_to_png():
    # Get license file absolute path
    license_path = os.path.abspath("./GroupDocs.Conversion.lic")

    if os.path.exists(license_path):
        # Create License and set the path
        license = License()
        license.set_license(license_path)

    # Load PDF document
    with Converter("./annual-review.pdf") as converter:
        # Create convert options
        png_convert_options = ImageConvertOptions()
        png_convert_options.format = ImageFileType.PNG
        
        # Convert document pages and save converted pages in the output folder
        converter.convert_by_page("./converted-pages", png_convert_options)    

if __name__ == "__main__":
    convert_pdf_pages_to_png()

Your folder tree should look similar to the following directory structure:

📂 demo-app
 ├──annual-review.pdf
 ├──convert_pdf_pages_to_png.py
 ├──groupdocs_conversion_net-24.11-py3-none-*.whl
 └──GroupDocs.Conversion.lic (Optionally)

py convert_pdf_pages_to_png.py

python3 convert_pdf_pages_to_png.py

After running the app you can deactivate virtual environment by executing deactivate or closing your shell.

• Converter("./annual-review.pdf"): Initializes the converter with the PDF file.
• ImageConvertOptions(): Specifies the output format as image.
• ImageFileType.PNG: Sets the output image format to PNG.
• converter.convert_by_page("./converted-pages", png_convert_options): Converts the PDF file pages to PNG and saves output file in converted-pages folder.

In this example we’ll convert documents packed into ZIP archive to PDF. You can download the app that we’re going to buid here.

import os
from groupdocs.conversion import License, Converter
from groupdocs.conversion.options.convert import PdfConvertOptions

def convert_files_in_archive():
    # Get license file absolute path
    license_path = os.path.abspath("./GroupDocs.Conversion.lic")

    if os.path.exists(license_path):
        # Create License and set the path
        license = License()
        license.set_license(license_path)

    # Load ZIP file
    with Converter("./compressed.zip") as converter:
        # Create convert options
        pdf_convert_options = PdfConvertOptions()
        
        # Extract ZIP and convert each file to PDF
        converter.convert_multiple("./converted-files", pdf_convert_options)    

if __name__ == "__main__":
    convert_files_in_archive()

Your folder tree should look similar to the following directory structure:

📂 demo-app
 ├──compressed.zip
 ├──convert_files_in_archive.py
 ├──groupdocs_conversion_net-24.11-py3-none-*.whl
 └──GroupDocs.Conversion.lic (Optionally)

py convert_files_in_archive.py

python3 convert_files_in_archive.py

After running the app you can deactivate virtual environment by executing deactivate or closing your shell.

• Converter("./compressed.zip"): Initializes the converter with the ZIP file.
• PdfConvertOptions(): Specifies the output format for files as PDF.
• converter.convert_multiple("./converted-files", pdf_convert_options): Extracts files from ZIP, converts each file to PDF saves output files in converted-files folder.

After completing the basics, explore additional resources to enhance your usage:

• Supported File Formats: Review the full list of supported file types.
• Licensing: Check details on licening and evaluation.
• Technical Support: Contact support for assistance if you encounter issues.