Skip to main content

Command Line Interfaces from custom classes

Project description

# ClassCLI
Command Line Interfaces from class definitions.

[![PyPI version](https://badge.fury.io/py/classcli.svg)](https://badge.fury.io/py/classcli) [![PyPI version](https://img.shields.io/badge/python-%3E%3D%203.5-blue.svg)](https://pypi.org/project/classcli/) [![Build Status](https://travis-ci.org/Hrabal/ClassCLI.svg?branch=master)](https://travis-ci.org/Hrabal/ClassCLI) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/ece6dfe1a5774a5992061515b36db0d4)](https://app.codacy.com/app/federicocerchiari/ClassCLI?utm_source=github.com&utm_medium=referral&utm_content=Hrabal/ClassCLI&utm_campaign=Badge_Grade_Dashboard) [![Maintainability](https://api.codeclimate.com/v1/badges/d281ff92c2d45c4f2e75/maintainability)](https://codeclimate.com/github/Hrabal/ClassCLI/maintainability) [![Coverage Status](https://coveralls.io/repos/github/Hrabal/ClassCLI/badge.svg?branch=master)](https://coveralls.io/github/Hrabal/ClassCLI?branch=master) [![Downloads](https://pepy.tech/badge/classcli)](https://pepy.tech/project/classcli) [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/Hrabal/ClassCLI/master/LICENSE)

Very similar to [Fire](https://github.com/google/python-fire), this is a Python module that let you build command line interfaces directly from collection of classes, saving you from writing boilerplate code.

ClassCLI is built on top of argparse, it create arguments of the cli by inspecting the classes in a given list or in a module. Each compatible class is transformed in a first-level argument, each function in a second-level argument, each function's argument in a third level argument.

ClassCLI uses docstrings to build the CLI's help, kwargs defaults to set CLI's pars defaults and type hints to infer CLI's pars types.

ClassCLI can be used to build CLI interfaces on top of existing APIs, or can be used to write scripts with a full-featured CLI writing commands and arguments as classes and functions.

Example code:
```python
from classcli import CliBuilder


class NonCommandClass:
pass


class MainCommand:
"""Docstring are used for help."""
callable_cls = True
command = 'foo'

def _base(self):
"""Docstring are used for help in methods too."""
print('This script is running as a foo.')

def with_args(self,
first_arg: int, # Type annotations are used to add a type check on the CLI arg
second_arg):
print('This script is running as a foo with %s %s.' % (first_arg, second_arg))


class SecondCommand:
callable_cls = True
command = 'bar'

def _base(self):
print('This script is running in a bar.')

def order(self,
order='Beer' # method kwargs are translated to optiona args in the form of "--arg"
):
print('You ordered a %s' % order)


if __name__ == '__main__':
CliBuilder(locals()).run_cli()

```


This projects's goals:
* this project should let fast CLI prototyping
* this project should stay lightweight

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

classcli-0.0.2.tar.gz (4.6 kB view details)

Uploaded Source

File details

Details for the file classcli-0.0.2.tar.gz.

File metadata

  • Download URL: classcli-0.0.2.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/28.8.0 requests-toolbelt/0.8.0 tqdm/4.19.1 CPython/3.6.4

File hashes

Hashes for classcli-0.0.2.tar.gz
Algorithm Hash digest
SHA256 e4c6a568ffc7e1036126a7220c37e29013b96b80d48fe08d9a36cec61f7f1798
MD5 97da5fe128c8c8b2f055f000b6574001
BLAKE2b-256 4ac1fbe28ccc3958449dc5fa23319f9f1a5685b8ce083960e71034d7faa8d792

See more details on using hashes here.

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