2021-09-01 15:42:46 +02:00
< h1 align = "center" > Moulinette< / h1 >
< div align = "center" >
[](https://github.com/YunoHost/moulinette/actions/workflows/tox.yml)
[](https://github.com/YunoHost/moulinette/blob/dev/LICENSE)
2012-10-06 16:22:15 +02:00
2021-09-01 16:04:17 +02:00
Moulinette is a small Python framework meant to easily create programs with unified CLI and API.
2012-10-06 16:22:15 +02:00
2021-09-01 16:04:17 +02:00
In particular, it is used as a base framework for the YunoHost project.
< / div >
2012-10-06 16:22:15 +02:00
2017-04-03 01:37:11 +02:00
Issues
------
2018-06-07 13:39:14 +02:00
- [Please report issues on YunoHost bugtracker ](https://github.com/YunoHost/issues ).
2017-04-03 01:37:11 +02:00
2014-03-26 01:44:58 +01:00
Overview
--------
2012-10-14 22:05:15 +02:00
2021-09-01 16:04:17 +02:00
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.
2012-10-06 16:22:15 +02:00
2021-09-01 16:04:17 +02:00
< div align = "center" > < img src = "doc/actionsmap.png" width = "700" / > < / div >
2013-04-22 09:39:30 +02:00
2021-09-01 16:04:17 +02:00
Translation
-----------
2013-04-22 09:39:30 +02:00
2021-09-01 16:04:17 +02:00
You can help translate Moulinette on our [translation platform ](https://translate.yunohost.org/engage/yunohost/?utm_source=widget )
2012-10-06 16:22:15 +02:00
2021-09-01 16:04:17 +02:00
< div align = "center" > < img src = "https://translate.yunohost.org/widgets/yunohost/-/moulinette/horizontal-auto.svg" alt = "Translation status" / > < / div >
2012-10-22 21:25:55 +02:00
2021-09-01 16:04:17 +02:00
Developpers
-----------
2019-07-28 22:05:59 +02:00
2021-09-01 16:04:17 +02:00
- You can learn how to get started with developing on YunoHost by reading [this piece of documentation ](https://yunohost.org/dev ).
- Specific doc for moulinette: https://moulinette.readthedocs.org
- Run tests with:
2019-07-28 22:05:59 +02:00
```
$ pip install tox
$ tox
```
