Skip to main content

A Regular CLI

Project description

ARC: A Regular CLI

A tool for building easy, and highly extendable CLI systems for Python 3.8

Docs

Installation

$ pip install arc-cli

Clone for development

$ git clone https://github.com/seanrcollings/arc
$ pip install -e arc

Quick Start

from arc import CLI

cli = CLI()

@cli.script("hello")
def hello():
    print("Hello, World!")

cli()

Reference getting started for more info

$ python example.py hello
Hello, World!

Tests

Run the full test suite with

$ python3 -m tests

Run a specific test case with

$ python3 -m tests [TEST CASE]

My Goals

  • Make a fully functioning, easy to use CLI creator
  • Teach myself how to upload and maintain package on PyPi
  • Do not rely on any third party packages (crazy, I know)

TODO

  • Refactor Config object to employ instances rather than the raw class
  • Write a parser for command line args
  • Refactor BaseConverter / Converters to make more sense

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-0.9.tar.gz (15.1 kB view hashes)

Uploaded Source

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