Skip to main content

A Regular CLI

Project description

ARC: A Regular CLI

A tool for building declarative, and highly extendable CLI systems for Python 3.9

ARC Features

  • Command line arguments based on python type hints
  • Arbitrary command nesting
  • Automatic --help documentation
  • Fully Extensible with custom middlewares, types, validators, parameter configurations, etc...

Docs

Quick Start

import arc

@arc.command
def hello(name: str):
    """My first arc program!"""
    arc.print(f"Hello {name}!")

hello()
$ python hello.py Sean
Hello, Sean!
$ python hello.py --help
USAGE
    hello.py [-h] [--] name

DESCRIPTION
    My first arc program!

ARGUMENTS
    name

OPTIONS
    --help (-h)  Displays this help message

Installation

$ pip install arc-cli

Clone for development

$ git clone https://github.com/seanrcollings/arc
$ poetry install

Tests

Tests are written with pytest

$ pytest

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

arc_cli-8.1.4a2.tar.gz (67.5 kB view hashes)

Uploaded Source

Built Distribution

arc_cli-8.1.4a2-py3-none-any.whl (90.3 kB view hashes)

Uploaded Python 3

Supported by

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