Skip to main content

kien is a line-based command parser for creating shell-like interfaces

Project description


# ![kien logo](./docs/logo.png)

kien is python3 library that allows you to create a custom line-based
command parser with the goal of creating shell-like interfaces. kien
is not a shell and doesn’t try to be.

If you want to provide an human and machine friendly text-based interface
on a serial device kien is for you. kien’s best-case scenario: you’re
just writing the code that actually does things.

kien has support for:

* (optional) keywords
* variables
* validation
* transformation
* auto-generated help and documentation
* dependency-injection

![Prompt example showing how the say-some-name example works in action](./docs/say-some-name-example.png)

## Examples

kien works by annotating functions with decorators. See the examples folder 😊

```sh
# run examples with pipenv
pipenv run example examples/say-some-name.py

# or using your shell powers
# (install dependencies first or initialize and load a virtualenv)
PYTHONPATH=. python3 examples/say-some-name.py
```

## Work in progress

* There are currently no tests

This is not because there shouldn’t be but because kien just
recently has been extracted from an application that only
tests the actual commands that kien executes. In this
sense there are tests that cover most of kien’s functionality
but they simple are not public. This being said: kien
should be and will have tests in the future.

* Output formatting & Terminal handling

The way kien handles the terminal and how it writes and formats
text are hard-coded and in some need for careful thought and
refactoring.

* There is little documentation

* JSON output for machines is not (yet) ready

## Say my name

kien is a pun and a homage to Commander Keen, because kien’s integral
part is called a *Commander*. kien also is a rather old way to refer
to a pine tree in german. There you go :)

Project details


Release history Release notifications

This version
History Node

0.2.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
kien-0.2.0.tar.gz (96.0 kB) Copy SHA256 hash SHA256 Source None Apr 27, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page