Skip to content

equinor/configsuite-tui

Repository files navigation

Config Suite TUI

configsuite-tui Code style: black MIT license Codacy Badge Codacy Badge Documentation Status

Introduction

Config Suite TUI is a text-based user interface extension for Config Suite. It provides a simplified, visual way of creating and editing configuration files for a given schema.

Config Suite TUI Screenshot

Features

  • Simplified editing of configuration files
  • Import and export YAML files
  • Instant validation
  • Plugin system to provide schemas from other python modules

Documentation

Check out the documentation on Read the Docs.

Installation

Installation of Config Suite TUI can easily be done using pip:

$ pip install configsuite-tui

Developer guidelines

Contributions to Config Suite is very much welcome! Bug reports, feature requests and improvements to the documentation or code alike. However, if you are planning a bigger chunk of work or to introduce a concept, initiating a discussion in an issue is encouraged.

Running the tests

The tests can be executed with python -m unittest.

Code formatting

The entire code base is formatted with black.

Pull request expectations

We expect a well-written explanation for smaller PR's and a reference to an issue for larger contributions. In addition, we expect the tests to pass on all commits and the commit messages to be written in imperative style. For more on commit messages read this.

License

Config Suite TUI is licensed under the MIT License. For more information we refer the reader to the LICENSE file.