Skip to content

Repository files navigation

GroupDocs.Redaction for Python via .NET - Code Examples

banner

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

GroupDocs.Redaction for Python via .NET is a document redaction API that permanently removes sensitive text, metadata, annotations, image areas, and pages from 40+ formats, including Word, Excel, PowerPoint, PDF, and images, with no Microsoft Office or other external software required.

Features

  • Text Redaction: Replace text matched by an exact phrase or a regular expression, or cover it with a colored box.
  • Text in Images: Redact text in scans and embedded images through the OCR engine of your choice.
  • Metadata & Annotations: Erase or rewrite metadata, comments, and other annotations.
  • Images & Pages: Cover areas of images and pages with a colored box, or remove whole pages.
  • Rasterized PDF: Save the redacted document as a rasterized PDF, so nothing redacted can be recovered.
  • Redaction Policies: Apply one reusable set of redactions to many documents.
  • On-Premise: No MS Office or OpenOffice installation required.

Supported File Formats

GroupDocs.Redaction for Python via .NET supports a wide range of file formats, including Word, Excel, PowerPoint, OpenDocument, PDF, Images, HTML, Markdown, Text, and many others. See the full list of supported formats for details.

Get Started

  1. Set Up Environment: Ensure that Python 3.6+ is installed on your system. The package itself supports Python 3.5-3.14; the examples use f-strings and need 3.6+.

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

    git clone git@github.com:groupdocs-redaction/GroupDocs.Redaction-for-Python-via-.NET.git
  3. Navigate to the Examples Folder

    cd ./GroupDocs.Redaction-for-Python-via-.NET/Examples
  4. Install Package: install dependencies with pip:

    pip install -r requirements.txt

    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_redaction_net-26.11.0-py3-none-win_amd64.whl
  5. Configure License (Optional): run_all_examples.py applies a license automatically when the GROUPDOCS_LIC_PATH environment variable holds the absolute path of your .lic file.

    With a license applied, examples run with the full feature set; without one, a process opens at most 25 documents, saved pages carry an evaluation notice, and long documents are cut short (a rasterized PDF keeps its first 4 pages). 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 system packages the examples need (libicu-dev, libfontconfig1, ttf-mscorefonts-installer, tesseract-ocr), and the groupdocs-redaction-net package preinstalled.

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

# Run unlicensed (evaluation mode)
docker run --rm redaction-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 \
    redaction-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-redaction-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/redaction/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.Redaction for Python via .NET documentation.

We also offer GroupDocs.Redaction packages for other platforms:


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

Used by

Contributors

Languages