GroupDocs.Annotation for Python via .NET - Code Examples

Product Page | Docs | Demos | API Reference | Blog | Search | Free Support | Temporary License

GroupDocs.Annotation for Python via .NET adds annotations, markups, and comments to documents and images: highlight, underline, strike out, or replace text; draw area, ellipse, point, arrow, distance, and polyline shapes; add watermarks, text fields, links, and image stamps; thread replies, manage annotation versions, and import or export annotations — all on-premise, with no MS Office or OpenOffice installation required.

Features

• Text Markup: Highlight, underline, strike out, squiggly-underline, redact, or replace text.
• Graphic Annotations: Add area, ellipse, point, arrow, distance, and polyline shapes with configurable pen and fill colors.
• Rich Annotations: Add watermarks, text fields, hyperlinks, and image stamps.
• Comments & Replies: Attach an author and threaded replies to any annotation.
• Manage Annotations: Add, update, get, and remove annotations by id, type, or instance.
• Versions: Keep and retrieve multiple annotation versions of a document.
• Import / Export: Export annotations to XML and import annotations from another document.
• On-Premise: No MS Office or OpenOffice installation required.

Supported File Formats

GroupDocs.Annotation for Python via .NET supports a wide range of file formats, including Word, Excel, PowerPoint, PDF, OpenDocument, CAD, Visio, email, and image formats. See the full list of supported formats for details.

Get Started

1. Set Up Environment: Ensure that Python 3.5+ is installed on your system.

2. Get the Code: Clone or download this repository.

   git clone git@github.com:groupdocs-annotation/GroupDocs.Annotation-for-Python-via-.NET.git

3. Navigate to the Examples Folder

   cd ./GroupDocs.Annotation-for-Python-via-.NET/Examples

4. Install Package: install dependencies with pip:

   pip install -r requirements.txt

   Temporary note: the 26.6.0 package on PyPI is currently broken, so requirements.txt installs the Linux wheel directly from the GroupDocs Releases site. On Windows or macOS, install the platform-specific wheel via the alternative step below until the PyPI release is republished.

   Alternatively, download the platform-specific .whl file from the GroupDocs Releases website and install it directly (adjust the filename to your platform — win_amd64, manylinux*_x86_64, macosx_*_arm64, macosx_*_x86_64):

   pip install ./groupdocs_annotation_net-26.6.0-py3-none-win_amd64.whl

5. Configure License (Optional): examples run with the full feature set when a license is available, looking in two places:

   • The GROUPDOCS_LIC_PATH environment variable — set it to the absolute path of your .lic file (recommended).
   • Any *.lic file in the repository root.

   Without a license, the library runs in evaluation mode (the trial build watermarks the output). Get a free 30-day temporary license for evaluation.

6. Run the Examples: To run all the examples, execute the following command:

   python ./run_all_examples.py

   You can also run individual examples by navigating to the folder containing the example script and running it. Output files are placed in the same folder as the script file.

Run with Docker

The repository ships a Dockerfile that builds a Linux image with Python 3.13, the .NET runtime dependencies (libicu-dev, libgdiplus, libfontconfig1), and the groupdocs-annotation-net package preinstalled.

# Build the image
docker build -t annotation-examples .

# Run unlicensed (evaluation mode)
docker run --rm annotation-examples

# Run with a license mounted from the host
docker run --rm \
    -v /path/to/license:/lic:ro \
    -e GROUPDOCS_LIC_PATH=/lic/your-license.lic \
    annotation-examples

On Windows with Git Bash, set export MSYS_NO_PATHCONV=1 before docker run to prevent MSYS from rewriting the mounted license path.

AI agents and LLM integration

The groupdocs-annotation-net wheel ships a bundled AGENTS.md reference for AI coding assistants (Claude Code, Cursor, GitHub Copilot in agent mode, and similar). Once the package is installed, the reference is discovered automatically at groupdocs/annotation/AGENTS.md — it covers canonical imports, quick-start usage, licensing, the API surface table, and troubleshooting.

For on-demand documentation lookups, combine the bundled AGENTS.md with the GroupDocs MCP server at https://docs.groupdocs.com/mcp. See the AI agents and LLM integration page for the per-tool setup snippets.

Continuous integration

The .github/workflows/ directory contains the CI matrix that runs the full example suite on every push. The matrix is reproducible locally via the Dockerfile above.

More Resources

Find additional details and examples in the GroupDocs.Annotation for Python via .NET documentation.

We also offer GroupDocs.Annotation packages for other platforms:

• GroupDocs.Annotation for .NET
• GroupDocs.Annotation for Java

---

Product Page | Docs | Demos | API Reference | Blog | Search | Free Support | Temporary License