Skip to content

docs: make 'python-moodle' the canonical command, 'py-moodle' the alias#84

Merged
erseco merged 1 commit into
mainfrom
docs-python-moodle-canonical
Jul 8, 2026
Merged

docs: make 'python-moodle' the canonical command, 'py-moodle' the alias#84
erseco merged 1 commit into
mainfrom
docs-python-moodle-canonical

Conversation

@erseco

@erseco erseco commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Summary

Follows #83 (which added the python-moodle console-script alias). Now uses python-moodle as the canonical command everywhere in the docs and documents py-moodle as the shorter alias, so the command name matches the package name.

Changes

  • All command examples across README.md and docs/** (courses/users/site/modules/sections/recipes/etc.) now use python-moodle ...; prose references to the tool use python-moodle.
  • The alias is documented as the shorter equivalent py-moodle (installation & quickstart notes, README intro).
  • pyproject.toml: list python-moodle first (canonical), py-moodle second (alias) — both still map to py_moodle.cli:app.
  • Makefile: generate the CLI reference (docs/cli.md) with --name python-moodle, so the auto-generated help shows the canonical command.
  • Preserved: the py-moodle-icon.png logo asset and the py_moodle import name. Also fixed a stray cd py-moodle and an inaccurate "project name is py-moodle" → python-moodle.

Verification

python -m typer py_moodle.cli.app utils docs --name python-moodle   # cli.md -> "python-moodle courses ..."
pyproject scripts == {python-moodle, py-moodle} -> py_moodle.cli:app
mkdocs build                                                        # clean; no stray "py-moodle <subcommand>" in rendered HTML
pytest tests/unit && flake8                                         # green

Backwards compatibility

Fully compatible — both commands still work; only the documented default changed. py-moodle remains a first-class alias.

Following the addition of the python-moodle console-script alias, use
python-moodle as the primary command everywhere and document py-moodle
as the shorter alias, so the command matches the package name.

- All command examples across README + docs (courses/users/site/modules/
  etc.) now use 'python-moodle ...'; prose references to the tool use
  'python-moodle'.
- Alias is documented (installation/quickstart notes, README) as the
  shorter equivalent 'py-moodle'.
- pyproject.toml: list python-moodle first (canonical) with py-moodle as
  the alias; both entry points unchanged functionally.
- Makefile: generate the CLI reference (docs/cli.md) with
  '--name python-moodle' so the auto-generated help shows the canonical
  command.
- Preserved: the py-moodle-icon.png logo asset and the py_moodle import
  name; fixed a stray 'cd py-moodle' and 'project name is py-moodle' to
  python-moodle along the way.

Verified: cli.md regenerates with 'python-moodle ...', pyproject scripts
= {python-moodle, py-moodle} both -> py_moodle.cli:app, mkdocs build
clean, no stray 'py-moodle <subcommand>' left in the rendered site,
pytest tests/unit + flake8 green.
@erseco erseco merged commit 2750ac9 into main Jul 8, 2026
30 of 33 checks passed
@erseco erseco deleted the docs-python-moodle-canonical branch July 8, 2026 06:11
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.

1 participant