Fix the README's test command and module map

Open Beginner friendly
  • Is something wrong?
#11 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read README.md sections on usage, the web UI and the module map, then compare the options with easyedit/main.py's parse() and easyedit/web.py's main(). Update the test command and document the listed scripts and files or remove them as appropriate. Done when the flag table covers every option in the CLI help, --no-browser is documented, and the test command is python -m unittest discover.

Written by the indexing model from the issue text.

Description

documentation good first issue

Three concrete mismatches:

  1. README.md:249 says tests/ unit tests (python -m pytest), but pytest is not in requirements.txt and the single test file uses unittest. A fresh clone running that command gets No module named pytest. The working command is python -m unittest discover.
  2. The "How it fits together" tree lists only easyedit/ and template/, omitting the top-level batch_edit.py, finish_three.py, fix_quotes.py, plans/, titles.txt, quotes-config.json, fixes.txt and fixes2.txt — none of which are mentioned anywhere in the README, AGENTS.md or the skill.
  3. The flag table omits --draft, --no-render and --preview, which appear only in the code block above it. python -m easyedit.web --no-browser is undocumented too.

Task: correct the test command, document or remove the stray scripts, and complete the flag table.

Where: README.md:145-199 (usage and flag table), README.md:228-251 (module map), README.md:129-140 (web UI). Compare easyedit/__main__.py → parse() and easyedit/web.py → main() (the undocumented flag is at web.py:418).

Done when: grep -n pytest README.md prints nothing and the README's test command is python -m unittest discover, which passes on a fresh clone. Every option in python -m easyedit --help, including --draft, --no-render and --preview, has a row in the flag table, and --no-browser is documented in the web UI section. Each of batch_edit.py, finish_three.py, fix_quotes.py, plans/, titles.txt, quotes-config.json, fixes.txt and fixes2.txt is either described in the module map or removed from the repo.

Getting started: Python 3.10+, Node 22+, FFmpeg on PATH. npm install, pip install -r requirements.txt, then python -m easyedit.doctor. Run python -m unittest discover before opening a PR. Passing --llm none skips the model entirely, which is the fastest way to test. Comment here to claim it. Questions → Discord.

Dominant language
Python
Stars
168
Forks
24
Avg merge
2d 10h
Merged PRs (30d)
14

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from blixvip/easyedit

All issues in blixvip/easyedit

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.