BSD Ports

devel/py-knack 0.11.0_2 DragonFly

Command line interface framework

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
MIT
Categories
devel, python
Package size
117.4 KiB, 736.4 KiB installed

Description

Knack is a Python command line parsing framework. Knack is built around the following patterns:

  • Be consistent with POSIX tools.
  • CLI success comes from ease and predictability of use so be consistent.
  • Support Piping and output direction to chain commands together.
  • Work with GREP, AWK, JQ and other common tools and commands.
  • Support productivity features like tab completion and parameter value completion.
  • Commands should follow a "[noun] [noun] [verb]" pattern.
  • For nouns that only support a single verb, the command should be named as a single hyphenated verb-noun pair.
  • Commands should support all output types (be consistent).
  • Exceptions are okay if only a 'raw' format makes sense e.g. XML.
  • Commands and arguments should have descriptions.
  • Include examples for the less straightforward commands.
  • Commands should return an object or dictionary, not strings/bools/etc.; logging.info("Upload of myfile.txt successful") NOT return "Upload successful".
  • Log to ERROR or WARNING for user messages; don't use print() function (by default it goes to STDOUT).
  • STDOUT vs. STDERR: STDOUT is used for actual command output. Everything else to STDERR (e.g. log/status/error messages).

In the other systems

SystemPortVersion
DragonFlydevel/py-knack0.11.0_2
FreeBSDdevel/py-knack0.14.0
HardenedBSDdevel/py-knack0.14.0
GhostBSDdevel/py-knack0.14.0

Install

Binary package:

pkg install py311-knack

From DPorts:

cd /usr/dports/devel/py-knack && make install clean

Dependencies

Run dependencies 6