mirror of https://github.com/YunoHost/moulinette.git synced 2024-09-03 20:06:31 +02:00

A small Python framework meant to easily create programs with unified CLI and API.

Find a file

Weblate cb3b0c0170 Merge branch 'dev' of https://github.com/YunoHost/moulinette into dev		2021-09-06 11:13:56 +00:00
.github/workflows	ci: fix names and PR body for i18n.yml	2021-09-03 16:42:52 +02:00
debian	python3-argcomplete seems unused in practice...	2021-08-27 22:05:23 +02:00
doc	🎨 Format Python code with Black	2021-08-23 13:25:51 +00:00
locales	Merge branch 'dev' of https://github.com/YunoHost/moulinette into dev	2021-09-06 11:13:56 +00:00
moulinette	🎨 Format Python code with Black	2021-09-03 13:53:54 +00:00
test	🎨 Format Python code with Black	2021-09-03 14:43:55 +00:00
.gitignore	Test documentation under Tox	2019-08-04 19:46:20 +02:00
CONTRIBUTORS.md	[enh][love] Add CONTRIBUTORS.md	2016-12-22 16:28:23 +01:00
LICENSE	Init	2012-10-06 16:22:15 +02:00
pytest.ini	[mod] during tests failed to translate string is an error	2019-07-28 21:29:50 +02:00
README.md	README: update description, translation and dev doc stuff	2021-09-01 16:04:17 +02:00
setup.cfg	Configuration tweaks fox tox/travis to use and check Black	2019-11-25 17:20:34 +01:00
setup.py	python3-argcomplete seems unused in practice...	2021-08-27 22:05:23 +02:00
tox.ini	github actions: only check invalidcode, linting is to be auto-handled by black	2021-08-27 22:13:31 +02:00

README.md

Moulinette

Moulinette is a small Python framework meant to easily create programs with unified CLI and API.

In particular, it is used as a base framework for the YunoHost project.

Issues

Please report issues on YunoHost bugtracker.

Overview

Moulinette allows to create a YAML "actionmaps" that describes what commands are available. Moulinette will automatically make these commands available through the CLI and Web API, and will be mapped to a python function. Moulinette also provide some general helpers, for example for logging, i18n, authentication, or common file system operations.

Translation

You can help translate Moulinette on our translation platform

Developpers

You can learn how to get started with developing on YunoHost by reading this piece of documentation.
Specific doc for moulinette: https://moulinette.readthedocs.org
Run tests with:

$ pip install tox
$ tox