A watermark library for text.
Project description
TextWatermark
TextWatermark is a library for inserting watermarks into text
Please take a look at our documentation for how to install and use TextWatermark:
Requirements
Tested on Python >= 3.10
Installation
Using Pip
$ pip install textwatermark
From Code
git clone https://github.com/JDArmy/TextWatermark.git
cd TextWatermark
pip install .
# or in editable mode
pip install --editable .
Usage
CMD Line
Insert watermark into text
$ textwatermark -v insert -f './tests/text/number.txt' -m ALPHA_NUMERICAL -t HOMOGRAPH_NUMBERS -x 999 -w 123
Ӏ2𝟑𝟒𝟓Ⳓ𝟟890
Export watermark parameters
$ textwatermark -v insert -f './tests/text/number.txt' -m ALPHA_NUMERICAL -t HOMOGRAPH_NUMBERS -x 999 -w 123 -e
{"tpl_type": "HOMOGRAPH_NUMBERS", "confusables_chars": [], "confusables_chars_key": "", "wm_base": 7, "method": 1, "wm_mode": 5, "wm_len": 7, "wm_loop": false, "start_at": 0, "version": "0.1.2"}
Retrieve the watermark from the text
$ textwatermark -v retrieve -f out.txt -p '{"tpl_type": "HOMOGRAPH_NUMBERS", "confusables_chars": [], "confusables_chars_key": "", "wm_base": 7, "method": 1, "wm_mode": 5, "wm_len": 7, "wm_loop": false, "start_at": 0, "version": "0.1.2"}'
The retrieved watermark is: 123
Coding
'''Sample Example'''
import os
from textwatermark.defines import WMMode
from textwatermark.main import TextWatermark
from textwatermark.template_type import WMTemplateType
# 1.Init TextWatermark instance
wm_mode = WMMode.REAL_NUMBER
wm = TextWatermark(wm_mode=wm_mode)
# 2.Choose a watermark template
wm.set_tpl_type(tpl_type=WMTemplateType.HOMOGRAPH_NUMBERS)
# 3.Set the maximum value of the watermark string
wm_max = '9'*9
wm.set_wm_max(wm_max=wm_max)
# 4.Set the text to be watermarked
wm.set_text_file(path=os.path.abspath('../tests/text/1.txt'))
# 5.Insert watermark string to text
wm_str = '123456789'
wm_text = wm.insert_watermark(wm_str=wm_str)
print(wm_text)
##############################################################
# Save the parameters to retrieve the watermark
params = wm.export_params()
# retrieve the watermark
wm_out_str = TextWatermark.retrieve_watermark(wm_text=wm_text, params=params)
assert wm_out_str == wm_str
More
See: Documents
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
textwatermark-0.2.1.tar.gz
(34.7 kB
view details)
Built Distribution
File details
Details for the file textwatermark-0.2.1.tar.gz
.
File metadata
- Download URL: textwatermark-0.2.1.tar.gz
- Upload date:
- Size: 34.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0534b4a868a0f7c87cc3b9429a4561a46169bea537bb10bceb4f846c6b05e38 |
|
MD5 | 3911f76d5ffe47a0f4bd89514e6eb787 |
|
BLAKE2b-256 | 57a15ccc103839f60fca3afbc8a94f190552f916bce1ace6b03c5809e0d4da55 |
File details
Details for the file textwatermark-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: textwatermark-0.2.1-py3-none-any.whl
- Upload date:
- Size: 42.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5796e6f7d707b901eb173d134aef1d3d7110735d2fad1c21bc78993b33c7b8c |
|
MD5 | 96b775e860c0434539489040588ab18c |
|
BLAKE2b-256 | dd8db39aae60c0f79709e600341321d7153f80249490c45a9befbd03101f54de |