Skip to content

docs: fix the README's test command, flag table and module map - #79

Merged
blixvip merged 1 commit into
blixvip:mainfrom
hskl18:docs/11-readme-test-command-and-module-map
Nov 17, 2026
Merged

blixvip merged 1 commit into
blixvip:mainfrom
hskl18:docs/11-readme-test-command-and-module-map

Conversation

@hskl18

@hskl18 hskl18 commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

What does this change?

Fixes #11. README and CONTRIBUTING only.

  • Test command. The module map said tests/ unit tests (python -m pytest), and pytest isn't in requirements.txt. It now says python -m unittest discover. I removed the CONTRIBUTING paragraph that pointed at the old README line, since it is no longer true.
  • Flag table. Added rows for --draft, --no-render and --preview (START END), worded from --help, and a row for -h, --help, so every option python -m easyedit --help prints has a row.
  • Web UI. One sentence for python -m easyedit.web --no-browser, which starts the server without opening your browser (web.py:615).
  • Module map. Described the eight top-level paths instead of removing them, since tests/test_batch_disk.py and tests/test_batch_qa.py import batch_edit. plans/ and the three movie lists are batch_edit.py's inputs (it copies plans/<slug>.json only into a job that has no plan yet). finish_three.py and fix_quotes.py are one-off helpers; whether to delete any of these is your call. I gave fix_quotes.py no command line: from reading the code (not run), quotes-config.json names transcripts by their names from before Re-transcribe when --language or the Whisper model changes #60, and since Re-transcribe when --language or the Whisper model changes #60 easyedit picks a new quote whenever quote.json has no files and transcripts, which this script's output lacks.

How did you test it?

  • python -m unittest discover passes: 90 tests in a fresh venv built from requirements.txt on main e77dec3 (Python 3.12, macOS; CI also covers 3.10). python -m pytest in the same venv gives No module named pytest.
  • python -m easyedit.doctor reports ready (CPU only).
  • Made a real edit end to end: not applicable, no code change.
  • UI changes checked in a real browser: no UI change.

I also checked the done-when items: grep -rn pytest README.md CONTRIBUTING.md prints nothing, every option in python -m easyedit --help matches a flag-table row, and each of the eight paths appears in the module map.

Checklist

  • One fix or feature, kept small and focused
  • Used the easyedit/util.py helpers: not applicable, no code change
  • No new runtime dependency
  • Nothing committed from jobs/, .cache/, node_modules/, or any footage
  • README updated if flags, behavior, or setup changed

OS tested: macOS.

@blixvip
blixvip merged commit 07ce70f into blixvip:main Nov 17, 2026
2 checks passed
@blixvip

blixvip commented Nov 17, 2026

Copy link
Copy Markdown
Owner

Thanks, @hskl18! The README now gives the right test command, lists every flag --help prints, and maps the real top-level files, so a new contributor can follow it without guessing.

If you'd like another one, #46 ("Fit the end-card title to the frame instead of letting it run off") is open and unclaimed.

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.

Fix the README's test command and module map

2 participants