openttd / bananas-frontend-cli

A CLI frontend for the BaNaNaS API

BaNaNaS CLI frontend

This is a CLI frontend for the OpenTTD's content service, called BaNaNaS. It works together with bananas-api, which serves the HTTP API.

See introduction.md for more documentation about the different BaNaNaS components and how they work together.

Development

This CLI tool is written in Python 3.8 with aiohttp, and makes strong use of asyncio.

Usage

To start it, you are advised to first create a virtualenv:

python3 -m venv .env
.env/bin/pip install -r requirements.txt

Next, check out the help.

.env/bin/python -m bananas_cli --help

bananas-frontend-cli's Issues

Add --browser option

Something like
--browser xdg-open
To open the auth URL without copy&paste.

Display command help text without authentication

Currently a command connects to the API and requires authentication, even if only asked for help:
.env/bin/python -m bananas_cli upload -h

Improve reporting on user errors

When the user specifies incorrect/insufficient options, the CLI usually prints a long backtrace.
Maybe add --verbose option to print backtraces, and hide them by default.

Examples:

When --api-url is wrong/missing:

• about 60 lines of python backtrace
• aiohttp.client_exceptions.ClientConnectorError: Cannot connect to host api.bananas.openttd.org:443 ssl:default [Name or service not known]

When uploading zero files:
.env/bin/python -m bananas_cli --api-url https://api.bananas.staging.openttd.org upload --version "foobar"

• 25 lines of python backtrace

• File ".../bananas_cli/commands/upload.py", line 31, in upload
  parts = files[0].split("/")[:-1]
  IndexError: tuple index out of range
  

Ending the API URL on a slash results in an error

Ending the API URL on a slash results in an error.

Please prepare the URL to not do this. Use URL-join functions where possible.

Prompt for TOS acceptance

Musa asked the important part

are you one of the authors of this content, if so answer 'yes I am':