docs: make 'python-moodle' the canonical command, 'py-moodle' the alias#84
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follows #83 (which added the
python-moodleconsole-script alias). Now usespython-moodleas the canonical command everywhere in the docs and documentspy-moodleas the shorter alias, so the command name matches the package name.Changes
README.mdanddocs/**(courses/users/site/modules/sections/recipes/etc.) now usepython-moodle ...; prose references to the tool usepython-moodle.py-moodle(installation & quickstart notes, README intro).pyproject.toml: listpython-moodlefirst (canonical),py-moodlesecond (alias) — both still map topy_moodle.cli:app.Makefile: generate the CLI reference (docs/cli.md) with--name python-moodle, so the auto-generated help shows the canonical command.py-moodle-icon.pnglogo asset and thepy_moodleimport name. Also fixed a straycd py-moodleand an inaccurate "project name is py-moodle" →python-moodle.Verification
Backwards compatibility
Fully compatible — both commands still work; only the documented default changed.
py-moodleremains a first-class alias.