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...

Links

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.3.0.tar.gz (68.8 kB view details)

Uploaded Source

Built Distribution

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

arc_cli-8.3.0-py3-none-any.whl (91.7 kB view details)

Uploaded Python 3

File details

Details for the file arc_cli-8.3.0.tar.gz.

File metadata

  • Download URL: arc_cli-8.3.0.tar.gz
  • Upload date:
  • Size: 68.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.9 Linux/6.2.13-arch1-1

File hashes

Hashes for arc_cli-8.3.0.tar.gz
Algorithm Hash digest
SHA256 3118f285894658aed81974395c32c708fee9c9e7a17952bebee13576b9b48cf5
MD5 2df8554c8e9dcbf1987f507df12f60ef
BLAKE2b-256 dc44fab274e4e18c897c6c5d736ad9620641342e98ac7da17ceae8db64418be7

See more details on using hashes here.

File details

Details for the file arc_cli-8.3.0-py3-none-any.whl.

File metadata

  • Download URL: arc_cli-8.3.0-py3-none-any.whl
  • Upload date:
  • Size: 91.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.10.9 Linux/6.2.13-arch1-1

File hashes

Hashes for arc_cli-8.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b9556bca4254d1920a4fe7a5eded62ca40d8660886c0e6cf221c18687e4927aa
MD5 7caa3bd673631c7947479fa23859dd37
BLAKE2b-256 58dccaa08772af4681bd796b1fce168b98f04d1f7c94076a313c0f1ea337b737

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