https://github.com/openttd/bananas-frontend-cli

A CLI frontend for the BaNaNaS API
https://github.com/openttd/bananas-frontend-cli

Last synced: about 1 year ago
JSON representation

A CLI frontend for the BaNaNaS API

• Host: GitHub
• URL: https://github.com/openttd/bananas-frontend-cli
• Owner: OpenTTD
• License: gpl-2.0
• Created: 2020-04-12T16:39:32.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T18:42:45.000Z (about 2 years ago)
• Last Synced: 2024-05-02T13:13:25.005Z (about 2 years ago)
• Language: Python
• Size: 59.6 KB
• Stars: 2
• Watchers: 6
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# BaNaNaS CLI frontend

[![GitHub License](https://img.shields.io/github/license/OpenTTD/bananas-frontend-cli)](https://github.com/OpenTTD/bananas-frontend-cli/blob/main/LICENSE)

[![GitHub Tag](https://img.shields.io/github/v/tag/OpenTTD/bananas-frontend-cli?include_prereleases&label=stable)](https://github.com/OpenTTD/bananas-frontend-cli/releases)

[![GitHub commits since latest release](https://img.shields.io/github/commits-since/OpenTTD/bananas-frontend-cli/latest/main)](https://github.com/OpenTTD/bananas-frontend-cli/commits/main)

[![GitHub Workflow Status (Testing)](https://img.shields.io/github/actions/workflow/status/OpenTTD/bananas-frontend-cli/testing.yml?branch=main&label=main)](https://github.com/OpenTTD/bananas-frontend-cli/actions/workflows/testing.yml)

This is a CLI frontend for the OpenTTD's content service, called BaNaNaS.

It works together with [bananas-api](https://github.com/OpenTTD/bananas-api), which serves the HTTP API.

See [introduction.md](https://github.com/OpenTTD/bananas-api/tree/main/docs/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:

```bash

python3 -m venv .env

.env/bin/pip install -r requirements.txt

```

Next, check out the help.

```bash

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

```