docs: Add initial extension development docs

2013-03-23 19:44:46 +01:00 · 2013-03-23 19:44:46 +01:00 · 19e3059a69
commit 19e3059a69
parent c1c5fff01f
2 changed files with 23 additions and 0 deletions
--- a/docs/index.rst
+++ b/docs/index.rst
@ -67,6 +67,7 @@ Development documentation
    :maxdepth: 3

    development
+    extensiondev


 Indices and tables
--- a/extensiondev.rst
+++ b/extensiondev.rst
@ -0,0 +1,22 @@
+*********************
+Extension development
+*********************
+
+.. warning:: Draft
+
+    This document is a draft open for discussion. It shows how we imagine that
+    development of Mopidy extensions should become in the future, not how to
+    currently develop an extension for Mopidy.
+
+An extension wants to:
+
+- Be automatically found if installed
+- Provide default config
+- Validate configuration
+- Validate presence of dependencies
+  - Python packages (e.g. pyspotify)
+  - Other software
+  - Other extensions (e.g. SoundCloud depends on stream backend)
+- Validate that needed TCP ports are free
+- Be asked to start running
+- Be asked to shut down