Skip to content

Incorrect REST API backend server initialization command in PyPI instructions #2380

@AliAsgharRanjbar

Description

@AliAsgharRanjbar

Bareos component version

PyPI package: bareos-restapi (latest release at the time of writing)

Steps to reproduce

  1. Install the bareos-restapi package from PyPI.

  2. Follow the instructions on the PyPI page which show:

uvicorn bareos-restapi:app --reload

  1. Run the command.

Expected results

The backend server should start successfully.

Actual results

Running the PyPI-documented command:

uvicorn bareos-restapi:app --reload

produces an import error, since Python modules cannot contain dashes in their names.

Environment

- OS: any (tested on Linux and Windows)
- component: bareos-restapi from PyPI

Relevant log output

Error loading ASGI app. Could not import module "bareos-restapi".

Relevant traces output

Anything else?

The issue is limited to the documentation on the PyPI page for bareos-restapi.
A small update to replace bareos-restapi with bareos_restapi in the example command will resolve this.

Metadata

Metadata

Labels

bugThis addresses a bug

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions