pasteup 0.1.0__tar.gz

pasteup-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,206 @@
+# Publish a tagged release to PyPI, the way sigrix-io/mullion does. Nothing else
+# in this repository publishes, and nothing here runs on a branch: a release is
+# a pushed `v*` tag, so publishing is an act with a name rather than a side
+# effect of a merge.
+#
+# Trusted publishing (OIDC) rather than an API token: the runner trades a
+# short-lived identity for the upload, so there is no long-lived secret in this
+# repository to store, leak or rotate. PyPI must be told which repository,
+# workflow file and environment it trusts: ftymoshchuk/pasteup, release.yml
+# and `pypi` (see `environment:` below).
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+# Read-only by default. Only the publish job widens this, and only to the one
+# permission the OIDC exchange needs.
+permissions:
+  contents: read
+
+# Deliberately not cancelled in progress, unlike tests.yml: a run stopped
+# mid-upload can leave a release half-landed, and PyPI never accepts the same
+# version number twice, not even after the file is deleted.
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  # Everything that can say no, said before anything leaves the runner.
+  build:
+    runs-on: ubuntu-latest
+    # A fork can push a tag to itself; it must not build the artifacts this
+    # repository's trusted publisher would then be asked to upload.
+    if: github.repository == 'ftymoshchuk/pasteup'
+    steps:
+      # The releases tests.yml runs on (its v5 and v6), pinned by commit: this
+      # runs once per release, the worst moment to meet an action's new major.
+      - uses: actions/checkout@fbc6f3992d24b796d5a048ff273f7fcc4a7b6c09 # v5.1.0
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.13"
+
+      - run: python -m pip install build twine
+      - run: python -m build
+
+      # hatchling reads the version from src/pasteup/__init__.py; the tag is
+      # typed by hand, and nothing else makes the two agree. Tagging v0.2.0
+      # without the bump would publish 0.1.0 under a tag saying otherwise, or
+      # fail at the upload with an error naming neither cause.
+      - name: The tag names the version that was built
+        run: |
+          set -euo pipefail
+          tag="${GITHUB_REF_NAME#v}"
+          # pasteup-0.1.0-py3-none-any.whl -> 0.1.0. A wheel filename uses "-"
+          # as its separator, so a PEP 440 version never contains one.
+          built="$(basename "$(ls dist/*.whl)" | cut -d- -f2)"
+          echo "tag=${tag}  built=${built}"
+          if [ "${tag}" != "${built}" ]; then
+            echo "::error::tag ${GITHUB_REF_NAME} does not name the packaged version ${built}. Bump __version__ in src/pasteup/__init__.py, or delete the tag and retag."
+            exit 1
+          fi
+
+      # Keep a Changelog puts the version in a heading, so both checks are
+      # exact. The second catches entries still filed under [Unreleased]: they
+      # are on the commit being tagged, so they ship while the changelog says
+      # they did not.
+      - name: The changelog names this version, and nothing is left unreleased
+        run: |
+          set -euo pipefail
+          export VERSION="${GITHUB_REF_NAME#v}"
+          python - <<'PY'
+          import os
+          import pathlib
+          import re
+
+          version = os.environ["VERSION"]
+          text = pathlib.Path("CHANGELOG.md").read_text()
+
+
+          def fail(message: str) -> None:
+              # stdout, not stderr: that is where GitHub reads ::error:: from.
+              print(message)
+              raise SystemExit(1)
+
+
+          if f"## [{version}]" not in text:
+              fail(
+                  f"::error::CHANGELOG.md has no '## [{version}]' heading. Add it, or "
+                  "move the Unreleased entries under it, before tagging."
+              )
+
+          section = re.search(
+              r"^##\s*\[Unreleased\]\s*$(.*?)(?=^##\s|\Z)",
+              text,
+              re.MULTILINE | re.DOTALL,
+          )
+          if section:
+              leftover = [
+                  line
+                  for line in section.group(1).splitlines()
+                  if line.strip() and not line.lstrip().startswith("#")
+              ]
+              if leftover:
+                  fail(
+                      f"::error::CHANGELOG.md still files {len(leftover)} line(s) under "
+                      f"[Unreleased], starting {leftover[0].strip()[:60]!r}. They ship in "
+                      f"{version}: move them under '## [{version}]' before tagging."
+                  )
+          PY
+
+      # A README that renders on GitHub but not on PyPI is otherwise found at
+      # the moment of publishing.
+      - run: python -m twine check --strict dist/*
+
+      # The preview-video tests encode real files; without ffmpeg they skip.
+      - name: Install ffmpeg
+        run: sudo apt-get update && sudo apt-get install --yes --no-install-recommends ffmpeg
+
+      # tests.yml proves the source tree; this proves the artifact, the only
+      # thing that matters once its bytes are immutable on PyPI. A template or
+      # font missing from the wheel fails here.
+      - name: The built wheel installs and passes the suite
+        run: |
+          set -euo pipefail
+          python -m venv /tmp/releasecheck
+          wheel="$(ls dist/*.whl)"
+          /tmp/releasecheck/bin/python -m pip install --quiet "${wheel}[dev]"
+          # The src layout leaves nothing in the checkout that `import pasteup`
+          # could find, so the suite can only be testing the wheel. Asserted
+          # rather than assumed.
+          /tmp/releasecheck/bin/python -c "import pasteup; assert 'site-packages' in pasteup.__file__, pasteup.__file__"
+          /tmp/releasecheck/bin/pasteup --version
+          /tmp/releasecheck/bin/python -m pytest -q tests/
+
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  # Separate from the build, so a failure above cannot half-publish: this job
+  # starts only when every check passed, and builds nothing itself.
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      # PyPI's trusted publisher names this environment alongside the
+      # repository and the workflow filename; all three must match what is set
+      # up there. It is also where to add a required reviewer, should a release
+      # ever need a second pair of eyes.
+      name: pypi
+      url: https://pypi.org/p/pasteup
+    permissions:
+      # The only elevated permission in this file: it mints the OIDC token PyPI
+      # exchanges for an upload, and lets the action attach attestations.
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+
+      # Pinned to the commit, not the tag: a tag can be moved by whoever owns
+      # the action, and this is the one step here holding a credential.
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+
+  # An upload that succeeded is not yet a package anyone can install. Install
+  # it by name from PyPI, the way a user would, and check it is this version
+  # and carries the app's files.
+  verify:
+    needs: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+        with:
+          python-version: "3.13"
+
+      - name: The published package installs by name and runs
+        run: |
+          set -euo pipefail
+          version="${GITHUB_REF_NAME#v}"
+          python -m venv /tmp/published
+          # A fresh upload can take a few minutes to be served everywhere.
+          for attempt in $(seq 1 20); do
+            if /tmp/published/bin/python -m pip install --quiet --no-cache-dir "pasteup==${version}"; then
+              break
+            fi
+            if [ "${attempt}" = 20 ]; then
+              echo "::error::pasteup ${version} still cannot be installed from PyPI after 20 attempts."
+              exit 1
+            fi
+            sleep 15
+          done
+          cd /tmp
+          test "$(/tmp/published/bin/pasteup --version)" = "pasteup ${version}"
+          /tmp/published/bin/python - <<'PY'
+          import pathlib
+
+          import pasteup
+
+          root = pathlib.Path(pasteup.__file__).parent
+          for asset in ("templates/index.html", "static/js/app.js", "static/fonts/caveat-latin-700.woff2"):
+              assert (root / asset).is_file(), f"{asset} did not ship"
+          print("pasteup", pasteup.__version__, "installs from PyPI with its files")
+          PY

pasteup-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,102 @@
+name: tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # 3.11 is the floor: mullion and the app's StrEnum use need it.
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      # The preview-video tests encode real files; without ffmpeg they skip.
+      - name: Install ffmpeg
+        run: sudo apt-get update && sudo apt-get install --yes --no-install-recommends ffmpeg
+
+      # A regular (not editable) install, so the tests run against the built
+      # package and fail if a template or static file is left out of it.
+      - name: Install
+        run: pip install ".[dev]"
+
+      # Lint first: a slip fails in seconds rather than after the suite.
+      - name: Lint
+        run: ruff check .
+
+      - name: Test
+        run: pytest -rs
+
+  # The package as users get it from PyPI: build it, check the README renders
+  # there, and install the wheel where the checkout cannot stand in for it.
+  # The release workflow repeats this; here a slip shows up on the pull request
+  # instead of at release time.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - run: python -m pip install build twine
+      - run: python -m build
+      - run: python -m twine check --strict dist/*
+
+      - name: The built wheel installs, runs and carries the app's files
+        run: |
+          set -euo pipefail
+          python -m venv /tmp/wheelcheck
+          /tmp/wheelcheck/bin/python -m pip install --quiet dist/*.whl
+          cd /tmp
+          /tmp/wheelcheck/bin/pasteup --version
+          /tmp/wheelcheck/bin/python - <<'PY'
+          import pathlib
+
+          import pasteup
+
+          root = pathlib.Path(pasteup.__file__).parent
+          assert "site-packages" in str(root), root
+          for asset in (
+              "templates/index.html",
+              "static/js/app.js",
+              "static/css/styles.css",
+              "static/favicon.svg",
+              "static/fonts/caveat-latin-700.woff2",
+              "static/fonts/patrick-hand-latin-400.woff2",
+          ):
+              assert (root / asset).is_file(), f"{asset} did not ship"
+          print("wheel ok:", pasteup.__version__)
+          PY
+
+  # The aggregate gate, as in sigrix-io/mullion: the one check the branch
+  # ruleset requires on main, so changing the matrix or adding a job does not
+  # mean editing the ruleset to match.
+  ci-passed:
+    if: always()
+    needs: [test, build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Every job succeeded
+        run: |
+          echo '${{ toJSON(needs) }}'
+          [ "${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}" = "false" ]

pasteup-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+.venv/
+build/
+dist/
+*.egg-info/

pasteup-0.1.0/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to Pasteup are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html). While Pasteup is
+0.x, a minor version may change behaviour.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-10-16
+
+The first release on PyPI.
+
+### Added
+- Preview sheets: every image of a bundle in 4x3 grids on a white page, as PNG
+  or JPG, sized in pixels, inches or millimetres, with the DPI stamped into
+  the file. A part-filled last page is optional.
+- Cover collages in three layouts, optionally limited to images you name.
+- Preview videos: an MP4 slideshow of the sheets, as long as you ask, with a
+  crossfade or flip between them. Needs ffmpeg.
+- Batch mode: every bundle folder inside a folder, listed, checked and made in
+  one go.
+- Image clean-up: transparent PNGs land on white, phone photos are turned
+  upright, and near-white backgrounds can be made pure white or transparent.
+- A hand-drawn browser interface in three steps, with each result beside the
+  step that made it. It runs entirely on your computer and needs no internet
+  connection.
+- The `pasteup` command opens the app in your browser, reuses a copy that is
+  already running and moves to a free port when another program has 8000.
+  `pasteup --shortcut` makes a double-click launcher.
+
+[Unreleased]: https://github.com/ftymoshchuk/pasteup/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ftymoshchuk/pasteup/releases/tag/v0.1.0

pasteup-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.