How to Run Examples Leave feedback

Every code example shown on this documentation site lives in a standalone, runnable form in the GroupDocs.Merger-for-Python-via-.NET repository on GitHub. Each example ships with its input sample files, so you can clone the repo and run anything with a single command.

Before running the examples, make sure you have:

1. A supported platform and Python version — see System Requirements. Windows, Linux, and macOS (Intel and Apple Silicon) are all supported.
2. Git — or download the repository as a ZIP from GitHub.
3. A license file (optional but recommended) — without one, the library runs in evaluation mode with a watermark on output and a 3-page cap on multi-page operations. See Licensing for how to obtain a free temporary license.

Clone the repository and navigate into it:

git clone https://github.com/groupdocs-merger/GroupDocs.Merger-for-Python-via-.NET.git
cd GroupDocs.Merger-for-Python-via-.NET

The repository mirrors this documentation tree. Every documentation page maps to a folder under Examples/, and every tabbed code block on a page maps to a .py file inside that folder. Input sample files live next to the script that reads them.

GroupDocs.Merger-for-Python-via-.NET
├── README.md
├── LICENSE
├── AGENTS.md                          ← extracted from the pip package for AI tools
├── Dockerfile                         ← runs the whole suite on Linux
├── .github/workflows/run-examples.yml ← CI: runs all examples on every push
└── Examples
    ├── requirements.txt
    ├── run_all_examples.py
    ├── getting-started
    │   └── quick-start-guide
    │       ├── merge_two_documents.py
    │       ├── extract_pages_from_pdf.py
    │       ├── split_document_pages.py
    │       ├── input.docx
    │       └── input.pdf
    ├── developer-guide
    │   ├── merge
    │   │   ├── merge_pdf_documents.py
    │   │   ├── merge_word_documents.py
    │   │   ├── merge_excel_documents.py
    │   │   ├── merge_powerpoint_documents.py
    │   │   └── (sample inputs: input.pdf, input.docx, input.xlsx, ...)
    │   ├── single-document-operations
    │   │   ├── split_document.py
    │   │   ├── extract_pages.py
    │   │   ├── remove_pages.py
    │   │   ├── swap_pages.py
    │   │   ├── move_page.py
    │   │   ├── rotate_pages.py
    │   │   └── change_page_orientation.py
    │   ├── security-operations
    │   │   ├── add_document_password.py
    │   │   ├── update_document_password.py
    │   │   ├── remove_document_password.py
    │   │   └── check_document_password.py
    │   ├── get_document_information.py
    │   ├── get_supported_file_types.py
    │   ├── page_preview.py
    │   └── loading-documents
    │       ├── load_from_local_disk.py
    │       ├── load_from_stream.py
    │       └── load_password_protected.py
    └── licensing
        ├── set_license_from_file.py
        └── set_metered_license.py

1. Create and activate a virtual environment:

   Create:

   Windows

   py -m venv .venv
   

   Linux

   python3 -m venv .venv
   

   macOS

   python3 -m venv .venv
   

   Activate:

   Windows

   .venv\Scripts\activate
   

   Linux

   source .venv/bin/activate
   

   macOS

   source .venv/bin/activate
   

2. Install dependencies from Examples/requirements.txt:

   Windows

   py -m pip install -r Examples/requirements.txt
   

   Linux

   python3 -m pip install -r Examples/requirements.txt
   

   macOS

   python3 -m pip install -r Examples/requirements.txt
   

3. Configure a license (optional). The suite honours the GROUPDOCS_LIC_PATH environment variable. Set it in your shell before running run_all_examples.py:

   Windows (PowerShell)

   $env:GROUPDOCS_LIC_PATH = "C:\path\to\GroupDocs.Merger.lic"
   

   Linux

   export GROUPDOCS_LIC_PATH="/path/to/GroupDocs.Merger.lic"
   

   macOS

   export GROUPDOCS_LIC_PATH="/path/to/GroupDocs.Merger.lic"
   

   Note

   Learn more about licensing, evaluation limits, and how to obtain a free 30-day temporary license in the Licensing documentation topic.

From the repository root, invoke run_all_examples.py. It imports every example in order, prints a per-file status line, and exits with a pass/fail summary.

py Examples\run_all_examples.py

python3 Examples/run_all_examples.py

python3 Examples/run_all_examples.py

Change into the folder that contains the script and run it directly. Input sample files live next to each script, so relative paths resolve correctly.

cd Examples/getting-started/quick-start-guide
python3 merge_two_documents.py

Every example writes its output artefacts into the same folder as the script.

The repository includes a Dockerfile that installs the ICU runtime, libgdiplus, libfontconfig1, and every Python dependency, then runs the full suite. Use it when you want a clean, reproducible Linux environment:

docker build -t groupdocs-merger-examples .
docker run --rm \
    -e GROUPDOCS_LIC_PATH=/license/GroupDocs.Merger.lic \
    -v /path/to/your/license:/license:ro \
    groupdocs-merger-examples

Every push to main triggers .github/workflows/run-examples.yml, which runs the entire example suite on ubuntu-latest with Python 3.13. Fork the repository and open a pull request — the workflow runs for free on GitHub-hosted runners.

• DllNotFoundException: libgdiplus on Linux — install the native dependency: sudo apt-get install libgdiplus libfontconfig1. See System Requirements.
• Garbled text or missing glyphs — install Microsoft TrueType fonts (ttf-mscorefonts-installer on Debian/Ubuntu) and run fc-cache -f so fontconfig picks them up.
• Evaluation watermark / page cap (3 pages) — set GROUPDOCS_LIC_PATH to a valid license file and re-run. In evaluation mode, multi-page documents are capped at 3 pages and outputs carry a watermark. Operations on documents with 3 pages or fewer are unaffected. See Licensing.
• Anything else — post on the free support forum or visit the Technical Support page.