Skip to main content

Simple and lightweight async console runner.

Project description

Async cli client/commander framework

PyPI version PyPIDownloads CI

aiocli is a Python library for simple and lightweight async console runner.

Full compatibility with argparse module and highly inspired by aiohttp module.

Installation

Use the package manager pip to install aiocli.

pip install aiocli

Documentation

Usage

from logging import getLogger, Logger, StreamHandler
from os import getenv

from aiocli.commander import run_app, Application, Depends, State

app = Application(state={
    'envs': {
        'LOGGER_NAME': str(getenv('LOGGER_NAME', 'example_app')),
        'LOGGER_LEVEL': str(getenv('LOGGER_LEVEL', 'INFO')),
    }
})

def _get_logger(state: State) -> Logger:
    logger = getLogger(state.get('envs')['LOGGER_NAME'])
    logger.setLevel(state.get('envs')['LOGGER_LEVEL'])
    handler = StreamHandler()
    logger.addHandler(handler)
    return logger

@app.command(name='greet:to', positionals=[('name', {'default': 'World!'})])
async def handle_greeting(name: str, logger: Logger = Depends(_get_logger)) -> int:
    logger.info(f'Hello {name}')
    return 0

@app.command(name='div', optionals=[('--a', {'type': float}), ('--b', {'type': float})])
async def handle_division(a: float, b: float, logger: Logger = Depends(_get_logger)) -> int:
    try:
        logger.info(f'Result {a} / {b} = {(a / b)}')
        return 0
    except BaseException as err:
        logger.error(f'Error: {err}')
        return 1

# python3 main.py <command> <positionals> <optionals>
if __name__ == '__main__':
    run_app(app)

Requirements

  • Python >= 3.10

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Project details


Download files

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

Source Distribution

aiocli-1.11.0.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

aiocli-1.11.0-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file aiocli-1.11.0.tar.gz.

File metadata

  • Download URL: aiocli-1.11.0.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for aiocli-1.11.0.tar.gz
Algorithm Hash digest
SHA256 6bb0955253271f10abecc3151d5c0cc04588a09aaa2a8a416be2ad9dd0dc09ec
MD5 2ac88c2710450b73ffcc63428e61bde3
BLAKE2b-256 9b2a77da431dec0a1e3af4f2daaa8586cb19e19642890c74fc6b1e383f00bfaf

See more details on using hashes here.

File details

Details for the file aiocli-1.11.0-py3-none-any.whl.

File metadata

  • Download URL: aiocli-1.11.0-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for aiocli-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1bb59bc317029080a24a51234b437378abc5668ee30189746edb57ab3076b414
MD5 3543ecfb29fd44fcb8fcb66633a9ad01
BLAKE2b-256 d0973fe92c52db3710df6804fd7310fc7eb4c38d83a57779081ee8364a302373

See more details on using hashes here.

Supported by

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