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

Alexandre Aubin f562a9b333 fix old logger mechanism remants		2023-09-27 20:15:57 +02:00
.github/workflows	quality: we're in python 3.11 bruh²	2023-09-27 20:09:48 +02:00
debian	Merge branch 'dev' into bookworm	2023-07-20 16:10:46 +02:00
doc	🎨 Format Python code with Black	2022-02-08 13:45:42 +00:00
locales	Translated using Weblate (Japanese)	2023-07-12 01:35:12 +02:00
moulinette	fix old logger mechanism remants	2023-09-27 20:15:57 +02:00
test	quality: fix test/conftest.py, there's no ActionFilter anymore	2023-09-27 20:06:34 +02: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	Rework actionsmap and m18n init, drop multiple actionsmap support	2021-11-17 19:24:26 +01:00
README.md	add lgtm badge	2021-12-30 14:39:30 +01:00
setup.cfg	Merge branch 'dev' into dont-take-lock-for-read-operations	2023-01-05 19:15:14 +01:00
setup.py	quality: we're in python 3.11 bruh³	2023-09-27 20:11:16 +02:00
tox.ini	quality: update tox.ini, bookworm has python 3.11	2023-09-27 20:04:15 +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