API reference

Warning

Documentation is stil under construction some things might not be up to date.

This file describes wiki_music API reference. Beware, some things might not be up to date and all is subject to change since we are still in early development phase.

Note

We often use throughout the documentation notation same as python typing. module to mark variable types as it is richer and preserves more information. e.g. List[str] obviously means list of strings. More on the matter can be read in the typing module documentation.

wiki_music main

Root file of wiki_music.

Sets which modules are lazy imported on package level and reads package __version__

wiki_music gui

wiki_music GUI entry point.

wiki_music.app_gui.main()

GUI entry point.

wiki_music cli

wiki_music CLI entry point.

wiki_music.app_cli.main()

CLI application entry point.