napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: mention python module descriptor key

Browse Source
This commit is contained in:
Adriaan de Groot 2019-03-11 17:04:47 -04:00
parent 2fdf799ee1
commit 5513b5a697
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/modules/README.md
View File

@ -50,6 +50,9 @@ Module descriptors **must** have the following keys:
- *interface* (see below for the different interfaces; generally we - *interface* (see below for the different interfaces; generally we
refer to the kinds of modules by their interface) refer to the kinds of modules by their interface)
Module descriptors for Python and PythonQt modules **must** have the following key:
- *script* (the name of the Python script to load, nearly always `main.py`)
Module descriptors **may** have the following keys: Module descriptors **may** have the following keys:
- *requiredModules* (a list of modules which are required for this module - *requiredModules* (a list of modules which are required for this module
to operate properly) to operate properly)
@ -131,7 +134,7 @@ or the experimental pythonqt job- and viewmodule interfaces.
To add a Python or process jobmodule, put it in a subdirectory and make sure To add a Python or process jobmodule, put it in a subdirectory and make sure
it has a `module.desc`. It will be picked up automatically by our CMake magic. it has a `module.desc`. It will be picked up automatically by our CMake magic.
For all kinds of Python jobs, the key *script* must be set to the name of For all kinds of Python jobs, the key *script* must be set to the name of
the main python file for the job. This is almost universally "main.py". the main python file for the job. This is almost universally `main.py`.
`CMakeLists.txt` is *not* used for Python and process jobmodules. `CMakeLists.txt` is *not* used for Python and process jobmodules.