pdfly 0.2.14__tar.gz → 0.3.0__tar.gz

pdfly-0.3.0/.github/dependabot.yml

@@ -0,0 +1,9 @@
+# Set update schedule for GitHub Actions
+
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

pdfly-0.3.0/.github/workflows/github-ci.yaml

@@ -0,0 +1,98 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.rst'
+  pull_request:
+    branches: [ main ]
+    paths-ignore:
+      - '**/*.md'
+      - '**/*.rst'
+  workflow_dispatch:
+
+jobs:
+  tests:
+    name: pytest on ${{ matrix.python-version }}
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+    - name: Setup Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Upgrade pip
+      run: python -m pip install --upgrade pip
+    - name: Install requirements (Python 3)
+      run: pip install -r requirements/ci.txt -r requirements/dev.txt
+    - name: Install pdfly
+      run: pip install .
+
+    - name: Run tests
+      run: pytest -vv
+
+  codestyle:
+    name: Check code style issues
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+    - name: Cache Downloaded Files
+      id: cache-downloaded-files
+      uses: actions/cache@v3
+      with:
+        path: '**/tests/pdf_cache/*'
+        key: cache-downloaded-files
+
+    - name: Upgrade pip
+      run: python -m pip install --upgrade pip
+    - name: Install requirements
+      run: pip install -r requirements/ci.txt
+    - name: Install pdfly
+      run: pip install .
+
+    - name: Lint with black
+      run: black --check --extend-exclude sample-files .
+    - name: Lint with mypy
+      run: mypy . --ignore-missing-imports --exclude build
+    - name: Test with ruff
+      run: |
+        echo `ruff --version`
+        ruff pdfly/
+
+  package:
+    name: Build & verify package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{env.PYTHON_LATEST}}
+
+      - run: python -m pip install flit check-wheel-contents
+      - run: flit build
+      - run: ls -l dist
+      - run: check-wheel-contents dist/*.whl
+
+      - name: Test installing package
+        run: python -m pip install .
+
+      - name: Test running installed package
+        working-directory: /tmp
+        run: python -c "import pdfly;print(pdfly.__version__)"

{pdfly-0.2.14 → pdfly-0.3.0}/.github/workflows/release.yaml

@@ -17,10 +17,10 @@ jobs:
     steps:
       # Ensure it's on PyPI
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
 
@@ -41,15 +41,18 @@ jobs:
         id: prepare_variables
         run: |
           git fetch --tags --force
+          latest_tag=$(git describe --tags --abbrev=0)
+          echo "latest_tag=$(git describe --tags --abbrev=0)" >> "$GITHUB_ENV"
           echo "date=$(date +'%Y-%m-%d')" >> "$GITHUB_ENV"
+          EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
           echo "tag_body<<$EOF" >> "$GITHUB_ENV"
-          git tag -l "${GITHUB_REF_NAME}" --format='%(contents:body)' >> "$GITHUB_ENV"
+          git --no-pager tag -l "${latest_tag}" --format='%(contents:body)' >> "$GITHUB_ENV"
           echo "$EOF" >> "$GITHUB_ENV"
       - name: Create GitHub Release 🚀
         uses: softprops/action-gh-release@v1
         with:
-          tag_name: ${{ github.ref }}
-          name: Version ${{ env.GITHUB_REF_NAME }}, ${{ env.date }}
+          tag_name: ${{ env.latest_tag }}
+          name: Version ${{ env.latest_tag }}, ${{ env.date }}
           draft: false
           prerelease: false
-          body: Body is ${{ env.tag_body }}
+          body: ${{ env.tag_body }}

{pdfly-0.2.14 → pdfly-0.3.0}/.gitignore

@@ -130,3 +130,7 @@ dmypy.json
 
 *.pdf
 .envrc
+
+# Documentation files copied when building:
+docs/meta/CHANGELOG.md
+docs/meta/CONTRIBUTORS.md

pdfly-0.3.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "sample-files"]
+	path = sample-files
+	url = git@github.com:py-pdf/sample-files.git

{pdfly-0.2.14 → pdfly-0.3.0}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 # pre-commit run --all-files
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     -   id: check-ast
     -   id: check-byte-order-marker
@@ -17,32 +17,36 @@ repos:
         exclude: "docs/make.bat"
     -   id: check-added-large-files
         args: ['--maxkb=1000']
-# -   repo: https://github.com/pre-commit/mirrors-mypy
-#     rev: v0.942
-#     hooks:
-#     -   id: mypy
 -   repo: https://github.com/psf/black
-    rev: 23.1.0
+    rev: 23.12.0
     hooks:
     -   id: black
         args: [--target-version, py36]
 -   repo: https://github.com/asottile/blacken-docs
-    rev: 1.13.0
+    rev: 1.16.0
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black==22.1.0]
--   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.254'
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.8
     hooks:
     -   id: ruff
-        args: [--fix]
+        args: ['--fix']
+        exclude: "tests/"
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.15.0
     hooks:
     -   id: pyupgrade
         args: [--py36-plus]
 -   repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+    rev: 6.1.0
     hooks:
     -   id: flake8
         args: ["--ignore", "E,W,F"]
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.7.1'
+    hooks:
+      - id: mypy
+        files: ^pypdf/.*
+        args: [--ignore-missing-imports]

pdfly-0.3.0/.readthedocs.yaml

@@ -0,0 +1,24 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats: all
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: requirements/docs.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - full

pdfly-0.3.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# CHANGELOG
+
+## Version 0.3.0, 2023-12-17
+
+### New Features (ENH)
+-  Add x2pdf command (#25)
+
+### Bug Fixes (BUG)
+-  boxes are floats, not int
+-  Add missing fpdf2 dependency (#29)
+
+### Documentation (DOC)
+-  cat command
+-  More examples for the cat subcommand
+-  Add cat subcommand
+-  Link to readthedocs
+-  Add project governance file
+-  Move readthedocs config file to root
+-  Add docs (#24)
+
+### Developer Experience (DEV)
+-  Checkout sample-files in CI (#30)
+-  Let dependabot update Github Actions
+-  Add action for automatic releases
+
+### Maintenance (MAINT)
+-  Update dependencies (#42)
+-  In the cat subcommand, replace the usage of the deprecated PdfMerger by PdfWriter (#34)
+-  Update .pre-commit-config.yaml
+-  Adjust x2pdf syntax
+
+### Testing (TST)
+-  cat with two files (#41)
+-  Test cat command with more parameters + validate result (#40)
+-  Adding unit tests (#28)
+
+### Other
+- : [{'msg': 'Bump actions/setup-python from 4 to 5 (#39)', 'author': 'dependabot[bot]'}, {'msg': 'test_extract_images_monochrome() is now passing', 'author': 'CimonLucas(LCM)'}, {'msg': 'Bump actions/setup-python from 3 to 4 (#27)', 'author': 'dependabot[bot]'}, {'msg': 'Bump actions/checkout from 3 to 4 (#26)', 'author': 'dependabot[bot]'}, {'msg': 'Ensure input PDF exists for cat subcommand', 'author': 'MartinThoma'}]
+
+[Full Changelog](https://github.com/py-pdf/pdfly/compare/0.2.14...0.3.0)

pdfly-0.3.0/CONTRIBUTORS.md

@@ -0,0 +1,41 @@
+# Contributors
+
+pdfly is a free software project without any company affiliation. We cannot pay
+contributors, but we do value their contributions 🤗
+
+The list might not be complete. You can find more contributors via the git
+history and [GitHubs 'Contributors' feature](https://github.com/py-pdf/pdfly/graphs/contributors).
+
+## Contributors to the pdfly project
+
+* [Thoma, Martin](https://github.com/MartinThoma): Creator of pdfly. [LinkedIn](https://www.linkedin.com/in/martin-thoma/) | [StackOverflow](https://stackoverflow.com/users/562769/martin-thoma) | [Blog](https://martin-thoma.com/)
+
+## Adding a new contributor
+
+Contributors are:
+
+* Anybody who has an commit in main - no matter how big/small or how many. Also if it's via co-authored-by.
+* People who opened helpful issues:
+  (1) Bugs: with complete MCVE
+  (2) Well-described feature requests
+  (3) Potentially some more.
+  The maintainers of pdfly have the last call on that one.
+* Community work: This is exceptional. If the maintainers of pdfly see people
+  being super helpful in answering issues / discussions or being very active on
+  Stackoverflow, we also consider them being contributors to pdfly.
+
+Contributors can add themselves or ask via an Github Issue to be added.
+
+Please use the following format:
+
+```
+* Last name, First name: 140-characters of text; links to linkedin / github / other profiles and personal pages are ok
+
+OR
+
+* GitHub Username: 140-characters of text; links to linkedin / github / other profiles and personal pages are ok
+```
+
+and add the entry in the alphabetical order. People who . The 140 characters are everything visible after the `Name:`.
+
+Please don't use images.

{pdfly-0.2.14 → pdfly-0.3.0}/Makefile

@@ -2,6 +2,7 @@ maint:
 	pre-commit autoupdate
 	pip-compile -U requirements/ci.in
 	pip-compile -U requirements/dev.in
+	pip-compile -U requirements/docs.in
 
 upload:
 	make clean

{pdfly-0.2.14 → pdfly-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdfly
-Version: 0.2.14
+Version: 0.3.0
 Summary: A pure-python CLI application to manipulate PDF files
 Author-email: Martin Thoma <info@martin-thoma.de>
 Maintainer-email: Martin Thoma <info@martin-thoma.de>
@@ -23,12 +23,15 @@ Requires-Dist: typer>=0.9.0
 Requires-Dist: pillow
 Requires-Dist: pydantic
 Requires-Dist: rich
+Requires-Dist: fpdf2
 Project-URL: Source, https://github.com/py-pdf/pdfly
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![PyPI version](https://badge.fury.io/py/pdfly.svg)](https://pypi.org/project/pdfly/)
 [![GitHub last commit](https://img.shields.io/github/last-commit/py-pdf/pdfly)](https://github.com/py-pdf/pdfly)
 [![Python Support](https://img.shields.io/pypi/pyversions/pdfly.svg)](https://pypi.org/project/pdfly/)
+[![Documentation Status](https://readthedocs.org/projects/pdfly/badge/?version=latest)](https://pdfly.readthedocs.io/en/latest/?badge=latest)
+[![](https://img.shields.io/badge/-documentation-green)](https://pdfly.readthedocs.io/en/latest/)
 
 # pdfly
 
@@ -63,6 +66,7 @@ $ pdfly --help
 │ extract-text     Extract text from a PDF file.                              │
 │ meta             Show metadata of a PDF file                                │
 │ pagemeta         Give details about a single page.                          │
+│ x2pdf            Convert one or more files to PDF. Each file is a page.     │
 ╰─────────────────────────────────────────────────────────────────────────────╯
 ```
 

{pdfly-0.2.14 → pdfly-0.3.0}/README.md

@@ -2,6 +2,8 @@
 [![PyPI version](https://badge.fury.io/py/pdfly.svg)](https://pypi.org/project/pdfly/)
 [![GitHub last commit](https://img.shields.io/github/last-commit/py-pdf/pdfly)](https://github.com/py-pdf/pdfly)
 [![Python Support](https://img.shields.io/pypi/pyversions/pdfly.svg)](https://pypi.org/project/pdfly/)
+[![Documentation Status](https://readthedocs.org/projects/pdfly/badge/?version=latest)](https://pdfly.readthedocs.io/en/latest/?badge=latest)
+[![](https://img.shields.io/badge/-documentation-green)](https://pdfly.readthedocs.io/en/latest/)
 
 # pdfly
 
@@ -36,6 +38,7 @@ $ pdfly --help
 │ extract-text     Extract text from a PDF file.                              │
 │ meta             Show metadata of a PDF file                                │
 │ pagemeta         Give details about a single page.                          │
+│ x2pdf            Convert one or more files to PDF. Each file is a page.     │
 ╰─────────────────────────────────────────────────────────────────────────────╯
 ```
 

pdfly-0.3.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pdfly-0.3.0/docs/conf.py

@@ -0,0 +1,125 @@
+"""
+Configuration file for the Sphinx documentation builder.
+
+This file only contains a selection of the most common options.
+For a full list see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+import os
+import shutil
+import sys
+
+import pdfly as py_pkg
+
+sys.path.insert(0, os.path.abspath("."))  # noqa
+sys.path.insert(0, os.path.abspath("../"))  # noqa
+
+shutil.copyfile("../CHANGELOG.md", "meta/CHANGELOG.md")
+shutil.copyfile("../CONTRIBUTORS.md", "meta/CONTRIBUTORS.md")
+
+# -- Project information -----------------------------------------------------
+
+project = py_pkg.__name__
+copyright = "2023, pdfly contributors"
+author = "pdfly contributors"
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = py_pkg.__version__
+# The full version, including alpha/beta/rc tags.
+release = py_pkg.__version__
+
+# -- General configuration ---------------------------------------------------
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = "4.0.0"
+
+myst_all_links_external = True
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    # External
+    "myst_parser",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.8", None),
+}
+
+nitpick_ignore_regex = [
+    # For reasons unclear at this stage the io module prefixes everything with _io
+    # and this confuses sphinx
+    (r"py:class", r"_io.(FileIO|BytesIO|Buffered(Reader|Writer))"),
+]
+
+autodoc_default_options = {
+    "member-order": "bysource",
+    "members": True,
+    "show-inheritance": True,
+    "undoc-members": True,
+}
+autodoc_inherit_docstrings = False
+autodoc_typehints_format = "short"
+python_use_unqualified_type_names = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    "canonical_url": "",
+    "analytics_id": "",
+    "logo_only": True,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    # Toc options
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# -- Options for Napoleon  -----------------------------------------------------
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False  # Explicitly prefer Google style docstring
+napoleon_use_param = True  # for type hint support
+napoleon_use_rtype = (
+    False  # False so the return type is inline with the description.
+)

pdfly-0.3.0/docs/index.rst

@@ -0,0 +1,34 @@
+.. pdfly documentation main file, created by
+   sphinx-quickstart on Sat Sep  9 11:39:00 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pdfly
+================
+
+pdfly is a command line tool to get informaiton about PDF documents and to manipulate them.
+
+.. toctree::
+   :caption: User Guide
+   :maxdepth: 1
+
+   user/installation
+   user/subcommand-meta
+   user/subcommand-cat
+   user/subcommand-x2pdf
+
+
+.. toctree::
+   :caption: About pypdf
+   :maxdepth: 1
+
+   meta/CHANGELOG
+   meta/CONTRIBUTORS
+   meta/project-governance
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pdfly-0.3.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd