The help command does not work

[matheusmms031]

Bug report

Environment

• Operating System: Windows 11 Home version 23H2
• Python version: 3.12

Description of the bug

When I run the:

poetry run scanapi --help

command, nothing appears other than a response that would be given when typing poetry run scanapi.

Important

Maybe I'm executing the help command wrong because of poetry run, but that's what the page says
wiki, and this was already the subject of discussion in
another issue from 4 years ago #312.

Expected behavior ?

I don't know, I couldn't find the code for the --help parameter

How to reproduce the the bug ?

Do a git clone on the repository with:

git clone [email protected]:scanapi/scanapi.git

Enter the repository with cd path/scanapi and execute the following lines of code:

poetry install <- Install dependency
poetry update <- Make sure everything is installed and updated
poetry run scanapi --help <- Execute the command help

Anthing else we need to know?

Using -h also gives an error.

[withtwoemms]

In trying to repo this issue, I ran into #675. That issue presented a blocker for further investigation. Can now continue trying to reproduce.

[withtwoemms]

While I get the same results on macOS 11.7.10; python v3.12.0, the claim:

"nothing appears other than a response that would be given when typing poetry run scanapi."

seems a non-issue as the intended sub-command is never invoked. Running poetry run scanapi invokes the "scripts:main" console script which correctly displays that there is one subcommand available:

$ poetry run scanapi
Usage: scanapi [OPTIONS] COMMAND [ARGS]...

  Automated Testing and Documentation for your REST API.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  run  Automated Testing and Documentation for your REST API.

Upon adding run to the poetry command, we gain access to the actual click command:

$ poetry run scanapi run -h
Usage: scanapi run [OPTIONS] [SPEC_PATH]

  Automated Testing and Documentation for your REST API. SPEC_PATH argument is
  the API specification file path.

Options:
  -o, --output-path PATH          Report output path.
  -nr, --no-report                Run ScanAPI without generating report.
  -b, --browser                   Open the results file using a browser
  -c, --config-path PATH          Configuration file path.
  -t, --template PATH             Custom report template path. The template
                                  must be a .jinja file.
  -ll, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Set the debug logging level for the program.
  -h, --help                      Show this message and exit.

I suppose it's unfortunate that the poetry command has this idiosyncratic symmetry with run being featured twice, but it's fine.

Recommendation:

Documentation may improve the experience though I am not a fan of RTFM approaches. It would be prudent to leverage the no_args_is_help option to a `click command declaration which allow the following incantation to produce the appropriate help message:

poetry run scanapi run

But even this requires run be featured a second time.

[matheusmms031]

Actually, I read your analysis and you are 100% correct, scanapi run and poetry run scanapi call the same main, but it's funny that we have to use another run to execute the help command.

However, as you said, I think it is more efficient for them to use the help that comes with the click library.

Maybe later I will fork the repository and fix this error and make a PR.