Quick Start Guide Leave feedback
On this page
This guide provides a quick overview of how to set up and start using GroupDocs.Watermark for Python via .NET. The library opens a document, lets you add text or image watermarks, search for or remove existing ones, and saves the result back to the original format.
To proceed, make sure you have:
- Configured environment as described in the System Requirements topic.
- 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 environments at the Create and Use Virtual Environments documentation topic.
Create a virtual environment:
py -m venv .venv
python3 -m venv .venv
python3 -m venv .venv
Activate a virtual environment:
.venv\Scripts\activate
source .venv/bin/activate
source .venv/bin/activate
After activating the virtual environment, run the following command in your terminal to install the latest version of the package:
py -m pip install groupdocs-watermark-net
python3 -m pip install groupdocs-watermark-net
python3 -m pip install groupdocs-watermark-net
Ensure the package is installed successfully. You should see the message
Successfully installed groupdocs-watermark-net-*
To quickly test the library, let’s open a PDF, add a diagonal “CONFIDENTIAL” text watermark, and save the result.
import os
from groupdocs.watermark import Watermarker, License
from groupdocs.watermark.watermarks import TextWatermark, Font, Color
def add_text_watermark():
# Optionally set a license
license_path = os.path.abspath("./GroupDocs.Watermark.lic")
if os.path.exists(license_path):
License().set_license(license_path)
# Open the document, add a text watermark, and save the result
with Watermarker("./sample.pdf") as watermarker:
watermark = TextWatermark("CONFIDENTIAL", Font("Arial", 48))
watermark.foreground_color = Color.red
watermark.opacity = 0.5
watermark.rotate_angle = 45.0
watermarker.add(watermark)
watermarker.save("./watermarked.pdf")
if __name__ == "__main__":
add_text_watermark()
sample.pdf is the sample file used in this example. Click here to download it.
Binary file (PDF, 351 KB)
Your folder tree should look similar to the following directory structure:
📂 demo-app
├──add_text_watermark.py
├──sample.pdf
└──GroupDocs.Watermark.lic (Optionally)
py add_text_watermark.py
python3 add_text_watermark.py
python3 add_text_watermark.py
After running the app you can deactivate the virtual environment by executing deactivate or closing your shell.
Watermarker("./sample.pdf"): Opens the document. Used as a context manager so the native document handle is released.TextWatermark("CONFIDENTIAL", Font("Arial", 48)): Builds a text watermark and its font.watermark.foreground_color/opacity/rotate_angle: Style the watermark (red, half-transparent, rotated 45°).watermarker.add(watermark)thenwatermarker.save("./watermarked.pdf"): Applies the watermark and writes the result.
In this example we stamp a logo image onto a Word document.
import os
from groupdocs.watermark import Watermarker, License
from groupdocs.watermark.watermarks import ImageWatermark
def add_image_watermark():
# Optionally set a license
license_path = os.path.abspath("./GroupDocs.Watermark.lic")
if os.path.exists(license_path):
License().set_license(license_path)
# Open the document, add an image watermark, and save the result
with Watermarker("./sample.docx") as watermarker:
watermark = ImageWatermark("./logo.png")
watermark.opacity = 0.5
watermarker.add(watermark)
watermarker.save("./watermarked.docx")
if __name__ == "__main__":
add_image_watermark()
sample.docx and logo.png are the sample files used in this example. Download sample.docx and logo.png.
Binary file (DOCX, 125 KB)
py add_image_watermark.py
python3 add_image_watermark.py
python3 add_image_watermark.py
ImageWatermark("./logo.png"): Builds an image watermark from a logo file. You can also pass a stream.watermark.opacity = 0.5: Makes the logo half-transparent so the underlying content stays readable.watermarker.add(watermark)thenwatermarker.save("./watermarked.docx"): Applies the watermark and writes the result.
Sometimes you only need a document’s metadata. get_document_info() returns the file type, page count, and size without modifying the document.
import os
from groupdocs.watermark import Watermarker, License
def get_document_info():
# Optionally set a license
license_path = os.path.abspath("./GroupDocs.Watermark.lic")
if os.path.exists(license_path):
License().set_license(license_path)
# Open the document and read its metadata
with Watermarker("./sample.pdf") as watermarker:
info = watermarker.get_document_info()
print("File type:", info.file_type)
print("Pages:", info.page_count)
print("Size, bytes:", info.size)
if __name__ == "__main__":
get_document_info()
sample.pdf is the sample file used in this example. Click here to download it.
File type: Pdf (.pdf) - Pdf
Pages: 3
Size, bytes: 271889
py get_document_info.py
python3 get_document_info.py
python3 get_document_info.py
watermarker.get_document_info(): Returns anIDocumentInfowith the document’sfile_type,page_count, andsize.
After completing the basics, explore additional resources to enhance your usage:
- Supported Document Formats: Review the full list of supported file types.
- Licensing and Subscription: Check details on licensing and evaluation.
- Developer Guide: Dive into adding, searching, modifying, and removing watermarks across every supported family.
- Technical Support: Contact support for assistance if you encounter issues.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
