YunoHost CLI
Python Shell
Switch branches/tags
Nothing to show
Pull request Compare This branch is 188 commits behind YunoHost:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
doc
lib/test
locales
moulinette
.gitignore
LICENSE
README.md
generate_api_doc.py
generate_function_doc.py
setup.py

README.md

Moulinette

The moulinette is a Python package that allows to quickly and easily prototype interfaces for your application.

Overview

Initially, the moulinette was an application made for the YunoHost project in order to regroup all its related operations into a single program called moulinette. Those operations were available from a command-line interface and a Web server providing an API. Moreover, the usage of these operations (e.g. required/optional arguments) was defined into a simple yaml file - called actionsmap. This file was parsed in order to construct an ArgumentParser object and to parse the command arguments to process the proper operation.

During a long refactoring with the goal of unify both interfaces, the idea to separate the core of the YunoHost operations has emerged. The core kept the same name moulinette and try to follow the same initial principle. An Actions Map - which defines available operations and their usage - is parsed and it's used to process an operation from several unified Interfaces. It also supports a configuration mechanism - which allows to restrict an operation on an interface for example (see Authenticators).

Actions Map

...

Interfaces

...

Authenticators

...

Requirements

  • Python 2.7
  • python-bottle (>= 0.10)
  • python-gnupg (>= 0.3)
  • python-ldap (>= 2.4)
  • PyYAML