tpdf-client 0.1.0__tar.gz

tpdf_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Timo Stein
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tpdf_client-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: tpdf-client
+Version: 0.1.0
+Summary: Python client for the tpdf command-line API
+Author: Timo Stein
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/tstone-1/tpdf
+Project-URL: Documentation, https://github.com/tstone-1/tpdf#command-line-tool
+Project-URL: Issues, https://github.com/tstone-1/tpdf/issues
+Keywords: pdf,redaction,signature,forms
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# tpdf-client
+
+A Python client for the [tpdf](https://github.com/tstone-1/tpdf) command-line tool: read,
+edit, fill, redact, sign and verify PDF documents from a script.
+
+**This package alone does not read a PDF.** The client starts the `tpdf` command-line tool
+and returns its JSON reports as dictionaries. The tool comes with the tpdf application for
+macOS and Windows, which has to be installed separately; see the
+[installation notes](https://github.com/tstone-1/tpdf#command-line-tool). There is no tool
+for Linux, so the client finds nothing to start there. It has no dependencies of its own.
+
+```
+pip install tpdf-client
+```
+
+The import name is `tpdf_client`, not `tpdf`: another project on PyPI has that name.
+
+```python
+from tpdf_client import Tpdf
+
+pdf = Tpdf()  # or Tpdf("/path/to/tpdf-cli", timeout=60)
+
+print(pdf.info("report.pdf")["files"][0]["document"]["pages"])
+
+report = pdf.redact("letter.pdf", "letter-redacted.pdf", texts=["Jane Doe"])
+assert report["written"] and report["verified"]
+
+pdf.merge(["cover.pdf", "report.pdf"], "combined.pdf")
+
+# Highlights every match in a copy. Returns None, and writes nothing, when nothing matched.
+pdf.mark_matches("report.pdf", "report-marked.pdf", texts=["North Pier"])
+
+for file in pdf.search("a.pdf", "b.pdf", texts=["North Pier"])["files"]:
+    for match in file["matches"]:
+        print(file["path"], match["page"], match["hit"])
+```
+
+`pdf.run(command, *arguments)` reaches every command and returns a `Result`; its `typed`
+property is the report, which the methods above return under the shape `tpdf_client.reports` names.
+
+Every method is described in the
+[tpdf README](https://github.com/tstone-1/tpdf#command-line-tool). Requires Python 3.10 or
+newer. MIT licence.

tpdf_client-0.1.0/README.md

@@ -0,0 +1,43 @@
+# tpdf-client
+
+A Python client for the [tpdf](https://github.com/tstone-1/tpdf) command-line tool: read,
+edit, fill, redact, sign and verify PDF documents from a script.
+
+**This package alone does not read a PDF.** The client starts the `tpdf` command-line tool
+and returns its JSON reports as dictionaries. The tool comes with the tpdf application for
+macOS and Windows, which has to be installed separately; see the
+[installation notes](https://github.com/tstone-1/tpdf#command-line-tool). There is no tool
+for Linux, so the client finds nothing to start there. It has no dependencies of its own.
+
+```
+pip install tpdf-client
+```
+
+The import name is `tpdf_client`, not `tpdf`: another project on PyPI has that name.
+
+```python
+from tpdf_client import Tpdf
+
+pdf = Tpdf()  # or Tpdf("/path/to/tpdf-cli", timeout=60)
+
+print(pdf.info("report.pdf")["files"][0]["document"]["pages"])
+
+report = pdf.redact("letter.pdf", "letter-redacted.pdf", texts=["Jane Doe"])
+assert report["written"] and report["verified"]
+
+pdf.merge(["cover.pdf", "report.pdf"], "combined.pdf")
+
+# Highlights every match in a copy. Returns None, and writes nothing, when nothing matched.
+pdf.mark_matches("report.pdf", "report-marked.pdf", texts=["North Pier"])
+
+for file in pdf.search("a.pdf", "b.pdf", texts=["North Pier"])["files"]:
+    for match in file["matches"]:
+        print(file["path"], match["page"], match["hit"])
+```
+
+`pdf.run(command, *arguments)` reaches every command and returns a `Result`; its `typed`
+property is the report, which the methods above return under the shape `tpdf_client.reports` names.
+
+Every method is described in the
+[tpdf README](https://github.com/tstone-1/tpdf#command-line-tool). Requires Python 3.10 or
+newer. MIT licence.

tpdf_client-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools>=77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tpdf-client"
+version = "0.1.0"
+description = "Python client for the tpdf command-line API"
+readme = "README.md"
+authors = [{ name = "Timo Stein" }]
+keywords = ["pdf", "redaction", "signature", "forms"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python :: 3",
+    "Topic :: Office/Business",
+]
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+
+[project.urls]
+Homepage = "https://github.com/tstone-1/tpdf"
+Documentation = "https://github.com/tstone-1/tpdf#command-line-tool"
+Issues = "https://github.com/tstone-1/tpdf/issues"
+
+[tool.setuptools.packages.find]
+include = ["tpdf_client"]
+
+[tool.setuptools.package-data]
+tpdf_client = ["py.typed"]

tpdf_client-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+