Skip to content

README: install pipx or uv first, and fill the API gaps - #8

Merged
ftymoshchuk merged 1 commit into
mainfrom
claude/affectionate-dirac-bdukrw
Oct 16, 2026
Merged

ftymoshchuk merged 1 commit into
mainfrom
claude/affectionate-dirac-bdukrw

Conversation

@ftymoshchuk

Copy link
Copy Markdown
Owner

What changes

README only.

  • No pipx yet? A new subsection under Install gives the one-time setup, followed by ensurepath and a new terminal window:
    • macOS: brew install pipx, or uv's installer if there is no Homebrew.
    • Windows: py -m pip install --user pipx, or uv's PowerShell installer.
    • Linux: the distribution's pipx package.
  • Troubleshooting: a new entry covers an older pip install of Pasteup coming first on PATH, which is what a pipx install would hit on a machine that had the earlier source install. Find copies with type -a pasteup / where pasteup, then remove the stale one with pip uninstall.
  • API docs (closes README: document images_skipped and the cover-collage endpoints, drop the stale MVP checklist #5):
    • images_skipped added to the /generate response fields.
    • The two cover-collage endpoints documented: request body, collage_template, image_fit, selected_cover_images and the response fields.
    • The stale "Acceptance Checklist (MVP Scope)" of unticked boxes removed; CHANGELOG.md now records what each release contains.
  • "Using the app" step 1 no longer says to open the address by hand, since pasteup opens it.

The README is also the PyPI project page, so PyPI shows these with the next release.

Checks

  • The install commands are taken from pipx's own docs (its 1.18.2 source package) and uv's installation docs.
  • pip install --user pipx was dry-run here. The uv installer host is blocked in this sandbox, so that one-liner was not run.
  • The cover-collage descriptions were checked against routes/jobs.py and services/cover_collage.py:
    • cover fills each tile and crops the overflow; contain keeps the whole image, with margins;
    • an include list with no matches is refused with a message.
  • Rendered with PyPI's renderer (readme_renderer[md], GFM): all new sections render. twine check --strict passes on a fresh build, and the 158 tests pass.

🤖 Generated with Claude Code

https://claude.ai/code/session_01E6aBDEnU4vqKQ4F9cnJMrL


Generated by Claude Code

A user without pipx now has the one-time setup: Homebrew's pipx on macOS
(or uv's installer without Homebrew), pip's --user pipx or uv's PowerShell
installer on Windows, and the distribution's pipx package on Linux, each
followed by `ensurepath` and a new terminal window. The commands are the
ones pipx's and uv's own docs give. Troubleshooting gains the case where an
older `pip install` of Pasteup comes first on PATH.

The API section documents `images_skipped` and the two cover-collage
endpoints, and the stale "Acceptance Checklist (MVP Scope)" of unticked
boxes is gone; CHANGELOG.md records what each release contains. "Using the
app" no longer tells the reader to open the address by hand.

Closes #5.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E6aBDEnU4vqKQ4F9cnJMrL
@ftymoshchuk
ftymoshchuk merged commit 52d24be into main Oct 16, 2026
5 checks passed
@ftymoshchuk
ftymoshchuk deleted the claude/affectionate-dirac-bdukrw branch October 16, 2026 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: document images_skipped and the cover-collage endpoints, drop the stale MVP checklist

2 participants