pdfly 0.3.3__tar.gz → 0.5.0__tar.gz

pdfly-0.5.0/.all-contributorsrc

@@ -0,0 +1,154 @@
+{
+  "projectName": "pdfly",
+  "projectOwner": "py-pdf",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "eslint",
+  "contributors": [
+    {
+      "login": "MartinThoma",
+      "name": "Martin Thoma",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1658117?v=4",
+      "profile": "http://martin-thoma.com/",
+      "contributions": [
+        "code",
+        "doc",
+        "ideas",
+        "infra",
+        "maintenance",
+        "projectManagement",
+        "tutorial"
+      ]
+    },
+    {
+      "login": "Lucas-C",
+      "name": "Lucas Cimon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/925560?v=4",
+      "profile": "https://chezsoi.org/lucas/blog/",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "pastor-robert",
+      "name": "Rob Adams",
+      "avatar_url": "https://avatars.githubusercontent.com/u/35646090?v=4",
+      "profile": "https://github.com/pastor-robert",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Kaos599",
+      "name": "Harsh ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/115716485?v=4",
+      "profile": "https://github.com/Kaos599",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "srogmann",
+      "name": "Sascha Rogmann",
+      "avatar_url": "https://avatars.githubusercontent.com/u/59577610?v=4",
+      "profile": "https://github.com/srogmann",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "ebotiab",
+      "name": "Enrique Botía",
+      "avatar_url": "https://avatars.githubusercontent.com/u/62219950?v=4",
+      "profile": "https://github.com/ebotiab",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kommade",
+      "name": "kommade",
+      "avatar_url": "https://avatars.githubusercontent.com/u/99523586?v=4",
+      "profile": "https://github.com/kommade",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Zingzy",
+      "name": "Zingzy",
+      "avatar_url": "https://avatars.githubusercontent.com/u/90309290?v=4",
+      "profile": "https://spoo.me/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "wolfram77",
+      "name": "Subhajit Sahu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3179612?v=4",
+      "profile": "https://wolfram77.github.io",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kianmeng",
+      "name": "Kian-Meng Ang",
+      "avatar_url": "https://avatars.githubusercontent.com/u/134518?v=4",
+      "profile": "https://www.kianmeng.org",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "hwine",
+      "name": "Hal Wine",
+      "avatar_url": "https://avatars.githubusercontent.com/u/132412?v=4",
+      "profile": "https://github.com/hwine",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "philippesamuel",
+      "name": "philippesamuel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32560769?v=4",
+      "profile": "https://github.com/philippesamuel",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "marcobrb",
+      "name": "marcobrb",
+      "avatar_url": "https://avatars.githubusercontent.com/u/219329309?v=4",
+      "profile": "https://github.com/marcobrb",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "moormaster",
+      "name": "moormaster",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2452695?v=4",
+      "profile": "https://github.com/moormaster",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    }
+  ],
+  "contributorsPerLine": 5,
+  "skipCi": false,
+  "commitType": "docs"
+}

pdfly-0.5.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report some unexpected behaviour to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+<!--
+Hi there! Thank you for wanting to make pdfly better 😉.
+
+Please perform a quick search first, in order to check if your problem has already been reported:
+https://github.com/py-pdf/pdfly/issues
+-->
+
+Describe the bug
+
+**Error details**
+If an exception is raised, it is very important that you provide the full error message.
+Otherwise members of the `pdfly` community won't be able to help you with your problem.
+
+**Environment**
+Please provide the following information:
+* **Operating System**: Windows, Mac OSX, Linux flavour...
+* **Python version**: you can get this information with `python --version`
+* **`pdfly` version used**: if you installed it with `pip`, you can get this information in `pip freeze` output
+
+<!-- Bonus / recommended:
+
+Often, there are bugfixes & other changes on pdfly git repo `master` branch
+that have not been released yet. They are listed in the ChangeLog:
+https://github.com/py-pdf/pdfly/blob/master/CHANGELOG.md
+
+Hence, please check that your bug is still present using the latest version of pdfly from the git repository, by installing it this way:
+
+    pip install git+https://github.com/py-pdf/pdfly.git@master
+
+-->

pdfly-0.5.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 Start a discussion
+    url: https://github.com/py-pdf/pdfly/discussions/new
+    about: Informal discussion about the project organization, considerations that do not expect a definitive answer, etc.
+#  - name: Security issue
+#    url: security@...
+#    about: Do not report security issues publicly. Email our security contact.

pdfly-0.5.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+---
+<!--
+Hi there! Thank you for wanting to make pdfly better 😉.
+
+Before you submit this, make sure that this feature wasn't already requested,
+or if it is not already implemented in the master branch but not released yet:
+https://github.com/py-pdf/pdfly/blob/master/CHANGELOG.md
+-->
+
+**Please explain your intent**
+Describe what you want to achieve.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+Please also mention any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context, code snippet or screenshots about the feature request.
+You can also mention if you are willing to contribute a PR yourself to provide this feature.

pdfly-0.5.0/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,14 @@
+---
+name: I have a question
+about: Anything that is not a bug report or a feature request
+title: ''
+labels: question
+assignees: ''
+---
+<!--
+Hi there! Thank you for reaching out and stepping in pdfly users community 😉.
+
+Before submitting your question, please check:
+* that it is not covered by the documentation: https://pdfly.readthedocs.io/en/latest/
+* that it has not already been asked: https://github.com/py-pdf/pdfly/issues
+-->

pdfly-0.5.0/.github/pull_request_template.md

@@ -0,0 +1,39 @@
+<!--
+Thanks for your interest in the project.
+Bugs filed and PRs submitted are appreciated!
+
+Some guidelines are provided like this, in HTML comments, to expedite the code review before merging your contribution.
+
+First, please make sure that you have read the documentation page on pdfly development:
+https://pdfly.readthedocs.io/en/latest/dev/intro.html
+
+If you're new to contributing to open source projects,
+you might find this free video course helpful: http://kcd.im/pull-request
+-->
+
+<!-- What changes are being made? (What feature/bug is being fixed here?) -->
+
+e.g. Fixes #0 <!-- This will automatically close issue #0 once the PR is merged: https://help.github.com/en/articles/closing-issues-using-keywords -->
+
+<!-- Have you done all of these things?  -->
+**Checklist**:
+
+<!-- To check an item, place an "x" in the box like so: "- [x] Item description"
+     Add "N/A" to the end of each line that's irrelevant to your changes -->
+
+- [ ] A unit test is covering the code added / modified by this PR
+
+- [ ] In case of a new feature, docstrings have been added, with also some documentation in the `docs/` folder
+
+- [ ] A mention of the change is present in `CHANGELOG.md`
+
+- [ ] This PR is ready to be merged <!-- In your opinion, can this be merged as soon as it's reviewed? Else, this can be turned into a Draft PR -->
+
+<!-- Feel free to add additional comments, and to ask questions if some of those guidelines are unclear to you! -->
+
+<!--
+Once a PR is merged, maintainers will add your name to the contributors table in README.md.
+If they forget, or you do not wish this to happen, please mention it.
+-->
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the [BSD 3-Clause license](https://github.com/py-pdf/pdfly/blob/master/LICENSE).

pdfly-0.5.0/.github/scripts/check_pr_title.py

@@ -0,0 +1,37 @@
+"""Check that all PR titles follow the desired scheme."""
+
+import os
+import sys
+
+KNOWN_PREFIXES = (
+    "SEC: ",
+    "BUG: ",
+    "ENH: ",
+    "DEP: ",
+    "PI: ",
+    "ROB: ",
+    "DOC: ",
+    "Docs: ",  # MRs from Dependabot
+    "TST: ",
+    "DEV: ",
+    "STY: ",
+    "MAINT: ",
+    "REL: ",
+)
+PR_TITLE = os.getenv("PR_TITLE", "")
+
+if (
+    not PR_TITLE.startswith(KNOWN_PREFIXES)
+    or not PR_TITLE.split(": ", maxsplit=1)[1]
+):
+    sys.stderr.write(
+        f"The PR title '{PR_TITLE}' does not follow the projects naming scheme: "
+        "https://pdfly.readthedocs.io/en/latest/dev/intro.html#commit-messages\n",
+    )
+    sys.stderr.write(
+        "If you do not know which one to choose or if multiple apply, make a best guess. "
+        "Nobody will complain if it does not quite fit :-)\n",
+    )
+    sys.exit(1)
+else:
+    sys.stdout.write(f"PR title '{PR_TITLE}' appears to be valid.\n")

pdfly-0.5.0/.github/workflows/check-gitignored-files.yml

@@ -0,0 +1,30 @@
+name: Check for Gitignored Files
+
+on:
+  push:
+    branches:
+      - '**' # Run on all branches
+  pull_request:
+
+jobs:
+  check-gitignored-files:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Check for gitignored files in commit
+        run: |
+          # List all files in the commit
+          git diff --name-only --cached > committed_files.txt
+
+          # Check if any of the committed files are ignored by .gitignore
+          git check-ignore -v $(cat committed_files.txt) > ignored_files.txt || true
+
+          # Fail if there are any ignored files
+          if [[ -s ignored_files.txt ]]; then
+            echo "The following files are gitignored but committed:"
+            cat ignored_files.txt
+            exit 1
+          fi

{pdfly-0.3.3 → pdfly-0.5.0}/.github/workflows/create-github-release.yaml

@@ -15,11 +15,13 @@ permissions:
 
 jobs:
   build_and_publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     name: Create a GitHub release page
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
       - name: Prepare variables
         id: prepare_variables
         run: |
@@ -31,8 +33,9 @@ jobs:
           echo "tag_body<<$EOF" >> "$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
+        uses: softprops/action-gh-release@6da8fa9354ddfdc4aeace5fc48d7f679b5214090 # v2.4.1
         with:
           tag_name: ${{ env.latest_tag }}
           name: Version ${{ env.latest_tag }}, ${{ env.date }}

{pdfly-0.3.3 → pdfly-0.5.0}/.github/workflows/github-ci.yaml

@@ -6,31 +6,25 @@ 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
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v4
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         submodules: 'recursive'
     - name: Setup Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -39,22 +33,29 @@ jobs:
     - name: Install requirements (Python 3)
       run: pip install -r requirements/ci.txt -r requirements/dev.txt
     - name: Install pdfly
+      if: matrix.python-version != '3.8'
       run: pip install .
+    - name: Install pdfly using the minimal versions of the dependencies
+      if: matrix.python-version == '3.8'
+      run: |
+        # We ensure that those minimal versions remain compatible:
+        sed -i '/dependencies = \[/,/\]/s/>=/==/' pyproject.toml
+        pip install .
 
     - name: Run tests
       run: pytest -vv
 
   codestyle:
     name: Check code style issues
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v4
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       with:
         submodules: 'recursive'
     - name: Cache Downloaded Files
       id: cache-downloaded-files
-      uses: actions/cache@v4
+      uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
       with:
         path: '**/tests/pdf_cache/*'
         key: cache-downloaded-files
@@ -71,17 +72,18 @@ jobs:
     - name: Lint with mypy
       run: mypy . --ignore-missing-imports --exclude build
     - name: Test with ruff
-      run: |
-        echo `ruff --version`
-        ruff pdfly/
+      run: ruff check pdfly/
+
+    - name: Spell Check Repo
+      uses: crate-ci/typos@80c8a4945eec0f6d464eaf9e65ed98ef085283d1 # v1.38.1
 
   package:
     name: Build & verify package
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: ${{env.PYTHON_LATEST}}
 

{pdfly-0.3.3 → pdfly-0.5.0}/.github/workflows/publish-to-pypi.yaml

@@ -15,11 +15,12 @@ permissions:
 
 jobs:
   build_and_publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     name: Publish a new version
     runs-on: ubuntu-latest
     steps:
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: 3.x
 
@@ -29,7 +30,7 @@ jobs:
           pip install flit
 
       - name: Checkout Repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Publish Package to PyPI🚀
         env:

{pdfly-0.3.3 → pdfly-0.5.0}/.github/workflows/release.yaml

@@ -19,7 +19,7 @@ jobs:
     if: "${{ startsWith(github.event.head_commit.message, 'REL: ') }}"
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Extract version from commit message
         id: extract_version

pdfly-0.5.0/.github/workflows/title-check.yml

@@ -0,0 +1,20 @@
+name: 'PR Title Check'
+on:
+  pull_request:
+    # check when PR
+    # * is created,
+    # * title is edited, and
+    # * new commits are added (to ensure failing title blocks merging)
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  title-check:
+    name: Title check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Check PR title
+        env:
+          PR_TITLE: ${{ github.event.pull_request.title }}
+        run: python .github/scripts/check_pr_title.py

{pdfly-0.3.3 → pdfly-0.5.0}/.gitignore

@@ -103,6 +103,7 @@ celerybeat.pid
 
 # Environments
 .env
+.envrc
 .venv
 env/
 venv/
@@ -114,6 +115,9 @@ venv.bak/
 .spyderproject
 .spyproject
 
+# IntelliJ
+.idea
+
 # Rope project settings
 .ropeproject
 

{pdfly-0.3.3 → pdfly-0.5.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.5.0
+    rev: v5.0.0
     hooks:
     -   id: check-ast
     -   id: check-byte-order-marker
@@ -18,34 +18,34 @@ repos:
     -   id: check-added-large-files
         args: ['--maxkb=1000']
 -   repo: https://github.com/psf/black
-    rev: 23.12.0
+    rev: 25.1.0
     hooks:
     -   id: black
         args: [--target-version, py36]
 -   repo: https://github.com/asottile/blacken-docs
-    rev: 1.16.0
+    rev: 1.19.1
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black==22.1.0]
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.8
+    rev: v0.9.5
     hooks:
     -   id: ruff
         args: ['--fix']
         exclude: "tests/"
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
+    rev: v3.19.1
     hooks:
     -   id: pyupgrade
-        args: [--py36-plus]
+        args: [--py38-plus]
 -   repo: https://github.com/pycqa/flake8
-    rev: 6.1.0
+    rev: 7.1.1
     hooks:
     -   id: flake8
         args: ["--ignore", "E,W,F"]
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.7.1'
+    rev: 'v1.15.0'
     hooks:
       - id: mypy
         files: ^pdfly/.*

{pdfly-0.3.3 → pdfly-0.5.0}/.readthedocs.yaml

@@ -5,7 +5,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

pdfly-0.5.0/.typos.toml

@@ -0,0 +1,6 @@
+[default]
+extend-ignore-identifiers-re = [
+    "FlateDecode",
+    # This typo appears in a .tex file in the sample-files git submodule:
+    "exampe"
+]