Optional Watermark Feature

[ByZay]

Hi everyone,

I hope you're doing well. Recently, I've been browsing GitHub looking for promising and interesting projects. I've been testing fdpf2 locally for a few days now, and it's truly admirable work from all the contributors. So, I'd like to ask if I could join you with some ideas I have.

I already have a few suggestions that I think would be a nice addition to the modules you've added to your code. I'd like to share them with you, please let me know what you think:

• Adding a transparent, low-opacity diagonal watermark to each generated PDF

Thank you for taking the time to read my message. I hope any help is welcome, and I’d be happy to be part of your project.

Have a great day,

Zay

[ByZay]

This is what it looks like :

from fpdf import FPDF
from pathlib import Path

class WatermarkPDF(FPDF):
    def __init__(self, watermark_text=None, opacity=0.3, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.watermark_text = watermark_text
        self.opacity = opacity

    def footer(self):
        if not self.watermark_text:
            return
        gray = int(255 * (1 - self.opacity))  
        self.set_font("Helvetica", "I", 8)
        self.set_text_color(gray, gray, gray)
        text_width = self.get_string_width(self.watermark_text)
        x = self.w - text_width - 10
        y = self.h - 10
        self.text(x, y, self.watermark_text)

[Lucas-C]

Hi @ByZay !

Bienvenue 🙂

Thank you for reaching out and offering your help 👍

Regarding watermarks, I'm not sure that such feature should be "builtin" in fpdf2,
as there are really many ways to render watermarks, depending on the font / image / opacity / etc.

Your solution is great!
We also had code snippets shared in the past regarding how to add wartermark using fpdf2:
#598 (comment)

Maybe we could have a dedicated section in our online documentation to collect such code snippets?
Today we only mention a few projects there: https://py-pdf.github.io/fpdf2/#community

You are also very welcome to help regarding the development of fpdf2, if you wish to contribute bugfixes or features!
You could have a look a our open issues, especially the ones labelled good first issue:
https://github.com/py-pdf/pdfly/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22

EDIT: I see that we both replied at the same time with @andersonhc 🙂

[ByZay]

Okay, perfect. I'll see if my help can be useful with some good ideas or issues (labelled "good first issue)

Thanks to take time to respond me 😄

Have great day guys.

Zay

[andersonhc]

Hi @ByZay

Thank you for the kind words.

You can definitely submit a PR with the tutorial 7 translation.

Regarding the watermark feature, I suggest you to open an issue with feature request and we can discuss the API for this feature.
Based on your example the watermark is only a substitution for footer()
Maybe we could create a way to register functions that are called every time a new page is added, and you can provide the watermark function for text or images.