Skip to main content

This framework aims to simplify the creation of Command-Line Interfaces (CLIs) using python.

Project description

The clinterfacer framework

Pipeline Status PyPI Version

This framework aims to simplify the creation of Command-Line Interfaces (CLIs) using python.


To install the clinterfacer framework using pip only, enter the following command:

pip install clinterfacer==1.3.0

However, if you are using pipenv, enter the following command in the root of your project.

pipenv install clinterfacer==1.3.0


After installation, it must be exist the follow files and folders in your project:

├── clinterfaced*
│   ├── commands*
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──*
│   │   └──
│   ├──*
│   ├──*
│   ├── resources**
│   │   ├──**
│   │   └── logging.ini**
│   ├── subparsers*
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──
│   │   ├──*
│   │   └──
│   └──
├── Makefile
├── Pipfile

All the above files and folders ending with * are expected by the clinterfacer framework. However, all the above files and folders ending with ** are opitional and are used by the clinterfacer framework to load the desired logging configuration. The remaining files and folders were merely used for exemplifying.

The file

There is a template for the file bellow.

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""This file is used to install the clinterfaced package."""

# standard library(ies)
import pathlib as pl
import typing

# 3rd party package(s)
import setuptools

# local source(s)
import clinterfaced as package

def read(path: typing.Union[str, pl.Path], encoding: str = 'utf-8') -> str:
    if isinstance(path, str):
        path = pl.Path(path)
    return path.read_text(encoding) if path.exists() else ''

readme = pathlib.Path('./')
metadata = {
    'name': package.__name__,
    'version': package.__version__,
    'author': package.__author__,
    'author_email': package.__email__,
    'maintainer': package.__maintainer__,
    'maintainer_email': package.__email__,
    'description': package.__description__,
    'long_description': read(readme),
    'long_description_content_type': 'text/markdown',
    'url': package.__url__,
    'packages': setuptools.find_packages(),
    'include_package_data': True,
    'install_requires': [
    'entry_points': {
        'console_scripts': [
            f'{package.__name__} = {package.__name__}.__main__:main',
    'classifiers': [
        'Programming Language :: Python :: 3',
        'Operating System :: OS Independent',
if __name __ == '__main__':

The file

#!/usr/bin/env python

""" This script includes all the project's metadata."""

__authors__ = (
    'Adriano Henrique Rossette Leite',
__email__ = (
__maintainer__ = (
    'Adriano Henrique Rossette Leite',
__copyright__ = ''
__credits__ = []
__license__ = ''
__version__ = '0.0.0' # this information should be altered only by the bumpversion tool
__status__ = 'Development' # should typically be one of 'Prototype', 'Development', 
__description__ = 'This package uses the clinterfacer framework.'
__url__ = ''
__author__ = ', '.join(__author__)
__email__ = ', '.join(__email__)
__maintainer__ = ', '.join(__maintainer__)
options = [
if __status__ is not in options:
    raise Exception(f'Invalid __status__: {__status__}. It should typically be one of the following: {options}')

The file

#!/usr/bin/env python

"""This is the main script of the clinterfaced package."""

# standard library(ies)
import sys

# 3rd party package(s)
import clinterfacer

def main() -> int:
    cli = clinterfacer.CLI()
    return cli.main()

if __name__ == '__main__':
    return sys.exit(main())

The commands folder

The script below is an example of the implementation of a command named as get-param.

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""This is the main script of the clinterfaced's get-param command."""

# standard library(ies)
import argparse
import logging
import sys

# local source(s)
from clinterfaced.subparsers.get_param import parse_args

logger = logging.getLogger(__name__)
parameters = {
    'framework': 'CLInterfacer',

def main(args: argparse.Namespace) -> None:'Getting parameter the clinterfaced\'s {args.parameter} paramenter ...')'Value for the {args.parameter} parameter: \'{parameters[args.parameter]}\'')

if __name__ == '__main__':
    args = parse_args()

The subparsers folder

The script below is an example of the definition of the arguments of a command named as get-param.

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""This script defines the clinterfaced's get-param subparser."""

# standard library(ies)
import argparse

# 3rd party package(s)
from clinterfacer import cli

def add_parser(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser(
        help='This is the get-param command of the clinterfaced package',
        prog='clinterfaced get-param',
        description='This command is the get-param one.',

def add_arguments(parser: argparse.ArgumentParser) -> None:
        help='Specifies the name of the desired paramenter.',

def parse_args() -> argparse.Namespace: 
    parser = argparse.ArgumentParser()
    args = parser.parse_args()
    return args

Installing the package

pipenv install clinterfacer 

Entering the commands in terminal

pipenv shell
clinterfaced build
clinterfaced config -f ./build.txt
clinterfaced train -t 0.6
clinterfaced deploy
clinterfaced doc -b html
exit # or Ctrl+D


git checkout master
git pull
git merge --no-ff new-feature
bumpversion [major|minor|patch]
git push origin master --tags
python sdist bdist_wheel
tar tzf dist/clinterfacer-1.3.0.tar.gz 
twine check dist/*
twine upload  --verbose --repository-url dist/*
twine upload  --verbose dist/*

Project details

Download files

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

Files for clinterfacer, version 1.3.0
Filename, size File type Python version Upload date Hashes
Filename, size clinterfacer-1.3.0-py3-none-any.whl (16.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size clinterfacer-1.3.0.tar.gz (12.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page