Skip to main content

a cli for mete

Project description

# metecli

[![Code Health](https://landscape.io/github/YtvwlD/metecli/master/landscape.svg?style=plastic)](https://landscape.io/github/YtvwlD/metecli/master)

This is a CLI for [mete](https://github.com/chaosdorf/mete/) (or any other server supporting the [Space-Market API](https://github.com/Space-Market/API) [v1](https://space-market.github.io/API/preview/v1)).

## Getting Started

### Installation

Although this isn’t strictly needed you might want to install metecli first before using it.

Upgrading (or downgrading) is done the same way as installing.

#### Installing the current stable version

sudo -H pip3 install metecli

#### Installing the development version

  1. Clone this repository. (git clone https://github.com/YtvwlD/metecli.git)

  2. Install it. (sudo -H ./setup.py install)

#### Or just use it without installing

  1. Clone this repository. (git clone https://github.com/YtvwlD/metecli.git)

  2. Install the dependencies (either via your distribution’s package manager or via pip): 1. requests 2. PyYAML 3. tabulate 4. typing (not needed when running on Python 3.5 or newer)

  3. Start it. (./run.sh)

  4. Remember to mentally replace metecli with ./run.sh in the next sections.

### Configuration

The initial configuration is done by calling metecli setup. You’ll see an exemplary invocation below:

` $ metecli setup Please enter the url for mete: http://mete/ The URL you entered doesn't use HTTPS. Do you want to try again? (y/n) n WARNING:metecli.setup:Using HTTP. The connection won't be secure. Do want to setup an account now? (y/n) y Do you already have an account? (y/n) y Please enter your username (or a part of it) or your uid: 1 `

metecli is now configured and ready.

## a few use-cases

### buy a drink

` $ metecli account buy Mate `

### deposit money

` $ metecli account deposit 2.50 `

### show information about your account

` $ metecli account show +----------------------------------+---------+ | ID | 2 | +----------------------------------+---------+ | name | test | +----------------------------------+---------+ | email | | +----------------------------------+---------+ | account balance | -1.50 ��� | +----------------------------------+---------+ | active? | no | +----------------------------------+---------+ | log transactions? | no | +----------------------------------+---------+ | redirect after buying something? | yes | +----------------------------------+---------+ `

### modify your account

` $ metecli account modify name [test]: email []: test@example.com account balance [-1.5]: active? [no]: yes log transactions? [no]: redirect after buying something? [yes]: `

### list your recent transactions

You’ll need to have the setting “log transactions” (audit) enabled for this to work.

` $ metecli account logs Audits for user 1: +--------------------------+---------+--------------+ | time | drink | difference | +==========================+=========+==============+ | 2017-09-11T09:01:23.816Z | Mate | -1.5 | +--------------------------+---------+--------------+ | 2017-09-10T13:41:50.372Z | n/a | -5 | +--------------------------+---------+--------------+ `

### list all drinks

` $ metecli drinks list All drinks: +------+---------+---------------+------------+---------+-----------+ | ID | name | bottle size | caffeine | price | active? | +======+=========+===============+============+=========+===========+ | 1 | Mate | 0.5 | | 1.50 ��� | yes | +------+---------+---------------+------------+---------+-----------+ | 2 | Cola | 0 | | 1.50 ��� | yes | +------+---------+---------------+------------+---------+-----------+ `

### display information about a drink

` $ metecli drinks show Mate +-------------+--------+ | ID | 1 | +-------------+--------+ | name | Mate | +-------------+--------+ | price | 1.50 ��� | +-------------+--------+ | bottle size | 0.5 | +-------------+--------+ | caffeine | | +-------------+--------+ | active? | yes | +-------------+--------+ `

### modify a drink

` $ metecli drinks modify Mate name [Mate]: price [1.5]: bottle size [0.5]: caffeine [None]: 100 active? [yes]: `

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

metecli-0.10.2-py2.py3-none-any.whl (40.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file metecli-0.10.2-py2.py3-none-any.whl.

File metadata

  • Download URL: metecli-0.10.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 40.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.12

File hashes

Hashes for metecli-0.10.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3e47e832caa68d9eb53a9a41a49d788fd6f71ee18bba3262dde7bad12bccd15c
MD5 ed34557659dd658a0e00b7c147c7df7d
BLAKE2b-256 21f381d7a1ed7303000b83a7a7580ebfd2c4bd592821877044b8f6bfbd035cdc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page