Skip to content

Extend helloworld RST with pip install-dependency command #1987

@chrisinmtown

Description

@chrisinmtown

Description

Provide instructions so a novice can start the Connexion v3 "helloworld" example on the first try.

Expected behaviour

The example runs on the first try.

Actual behaviour

It takes a few tries to install all the prerequisites.

Steps to reproduce

python hello.py

Proposed addition to README.rst

  • Create a new virtual environment
  • Run pip install 'connexion[flask,swagger-ui,uvicorn]>=3.1.0'

Discussion :)

I realize this is fairly trivial. Just trying to save the next person a little time.

And if you don't mind another suggestion, you might consider renaming the directory to "helloworld_flask", to keep it parallel with "helloworld_async" and similar names.

Please comment. I don't want to waste your time with a PR if this looks silly to you.

Metadata

Metadata

Assignees

No one assigned

    Labels

    PR welcomeWe would welcome and review a PR addressing this issuedocumentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions