victorliun / flexer

Flexer Client and Command Line Tools

flexer

Flexer is a command line tool for interacting with nFlex and running nFlex modules locally.

Installation

Install, upgrade and uninstall flexer with these commands:

$ pip install flexer
$ pip install --upgrade flexer
$ pip uninstall flexer

or fork this repository

Dependencies

The flexer tool is supported on Python 2.7.

The main dependencies are:

• requests: HTTP for Humans
• click: for creating beautiful command line interfaces
• jsonschema: an implementation of JSON Schema for Python
• jinja2: modern and designer-friendly templating language for Python
• pyyaml: YAML parser and emitter for Python

The testing dependencies are:

• pytest: helps you write better programs
• mock: a library for testing in Python

Testing

Make sure you have tox by running the following:

$ pip install tox

To run the package tests:

$ tox

or

$ make test

Bash Completion

For detailed explanation on how to enable bash completion for the flexer script, please read the click documentation.

Basically you need to run

_FLEXER_COMPLETE=source flexer > ~/flexer-complete.sh

and add this line to your .bashrc file:

source ~/flexer-complete.sh

License

GNU General Public License, version 2