core: introduce install-eaf.py & standardize dependency installation

Introduce the universal install-eaf.py to install EAF applications along with its dependencies, give the freedom to install any application as one wishes. Introduce dependencies.json in EAF core repo and in all app/foo/, to standardize dependency declaration across the framework. Developing EAF applications has never been this easier, it doesn't have to be within the emacs-eaf organization, you can put it in your own repository. Simply follow these steps: 1. Ensure the dependencies.json in your application repo is following the standard in other EAF applications. 2. Add to .gitmodules in the EAF core, also add it to the EAF core applications.json. 3. Submit a PR at EAF core repo: https://github.com/emacs-eaf/emacs-application-framework Also addresses #726 Signed-off-by: Mingde (Matthew) Zeng <matthewzmd@posteo.net>
emacs-eaf · Aug 11, 2021 · 044b0b8 · 044b0b8 · MatthewZMD · Aug 12, 2021
1 parent c6d9f33
commit 044b0b8
Show file tree

Hide file tree

Showing 31 changed files with 338 additions and 171 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,60 @@
+[submodule "app/airshare"]
+	path = app/airshare
+	url = https://github.com/emacs-eaf/eaf-airshare.git
+[submodule "app/browser"]
+	path = app/browser
+	url = https://github.com/emacs-eaf/eaf-browser.git
+[submodule "app/camera"]
+	path = app/camera
+	url = https://github.com/emacs-eaf/eaf-camera.git
+[submodule "app/demo"]
+	path = app/demo
+	url = https://github.com/emacs-eaf/eaf-demo.git
+[submodule "app/file-browser"]
+	path = app/file-browser
+	url = https://github.com/emacs-eaf/eaf-file-browser.git
+[submodule "app/file-manager"]
+	path = app/file-manager
+	url = https://github.com/emacs-eaf/eaf-file-manager.git
+[submodule "app/file-sender"]
+	path = app/file-sender
+	url = https://github.com/emacs-eaf/eaf-file-sender.git
+[submodule "app/image-viewer"]
+	path = app/image-viewer
+	url = https://github.com/emacs-eaf/eaf-image-viewer.git
+[submodule "app/js-video-player"]
+	path = app/js-video-player
+	url = https://github.com/emacs-eaf/eaf-js-video-player.git
+[submodule "app/jupyter"]
+	path = app/jupyter
+	url = https://github.com/emacs-eaf/eaf-jupyter.git
+[submodule "app/markdown-previewer"]
+	path = app/markdown-previewer
+	url = https://github.com/emacs-eaf/eaf-markdown-previewer.git
+[submodule "app/mindmap"]
+	path = app/mindmap
+	url = https://github.com/emacs-eaf/eaf-mindmap.git
+[submodule "app/music-player"]
+	path = app/music-player
+	url = https://github.com/emacs-eaf/eaf-music-player.git
+[submodule "app/netease-cloud-music"]
+	path = app/netease-cloud-music
+	url = https://github.com/emacs-eaf/eaf-netease-cloud-music.git
+[submodule "app/org-previewer"]
+	path = app/org-previewer
+	url = https://github.com/emacs-eaf/eaf-org-previewer.git
+[submodule "app/pdf-viewer"]
+	path = app/pdf-viewer
+	url = https://github.com/emacs-eaf/eaf-pdf-viewer.git
+[submodule "app/system-monitor"]
+	path = app/system-monitor
+	url = https://github.com/emacs-eaf/eaf-system-monitor.git
+[submodule "app/terminal"]
+	path = app/terminal
+	url = https://github.com/emacs-eaf/eaf-terminal.git
+[submodule "app/video-player"]
+	path = app/video-player
+	url = https://github.com/emacs-eaf/eaf-video-player.git
+[submodule "app/vue-demo"]
+	path = app/vue-demo
+	url = https://github.com/emacs-eaf/eaf-vue-demo.git
diff --git a/README.md b/README.md
@@ -103,8 +103,8 @@ If you prefer to manually call the installation script in the terminal,
 
     ```Bash
     cd emacs-application-framework
-    chmod +x ./install-eaf.sh
-    ./install-eaf.sh
+    chmod +x ./install-eaf.py
+    python ./install-eaf.py
     ```
 
 - If you use Windows,

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -101,8 +101,8 @@ EAF是一个可编程扩展的框架，它自带一系列丰富的应用，你
 
     ```Bash
     cd emacs-application-framework
-    chmod +x ./install-eaf.sh
-    ./install-eaf.sh
+    chmod +x ./install-eaf.py
+    python ./install-eaf.py
     ```
 
 - Windows用户：

diff --git a/app/airshare b/app/airshare
diff --git a/app/browser b/app/browser
diff --git a/app/camera b/app/camera
diff --git a/app/demo b/app/demo
diff --git a/app/file-browser b/app/file-browser
diff --git a/app/file-manager b/app/file-manager
diff --git a/app/file-sender b/app/file-sender
diff --git a/app/image-viewer b/app/image-viewer
diff --git a/app/js-video-player b/app/js-video-player
diff --git a/app/jupyter b/app/jupyter
diff --git a/app/markdown-previewer b/app/markdown-previewer
diff --git a/app/mindmap b/app/mindmap
diff --git a/app/music-player b/app/music-player
diff --git a/app/netease-cloud-music b/app/netease-cloud-music
diff --git a/app/org-previewer b/app/org-previewer
diff --git a/app/pdf-viewer b/app/pdf-viewer
diff --git a/app/system-monitor b/app/system-monitor
diff --git a/app/terminal b/app/terminal
diff --git a/app/video-player b/app/video-player
diff --git a/app/vue-demo b/app/vue-demo
diff --git a/applications.json b/applications.json
@@ -0,0 +1,22 @@
+{
+    "airshare": "EAF Airshare",
+    "browser": "EAF Browser",
+    "camera": "EAF Camera",
+    "demo": "EAF Demo",
+    "file-browser": "EAF File Browser",
+    "file-manager": "EAF File Manager",
+    "file-sender": "EAF File Sender",
+    "image-viewer": "EAF Image Viewer",
+    "js-video-player": "EAF Video Player (JS)",
+    "jupyter": "EAF Jupyter",
+    "markdown-previewer": "EAF Markdown Previewer",
+    "mindmap": "EAF Mindmap",
+    "music-player": "EAF Music Player",
+    "netease-cloud-music": "EAF NetEase Cloud Music",
+    "org-previewer": "EAF Org Previewer",
+    "pdf-viewer": "EAF PDF Viewer",
+    "system-monitor": "EAF System Monitor",
+    "terminal": "EAF Terminal",
+    "video-player": "EAF Video Player",
+    "vue-demo": "EAF Vue Demo"
+}
diff --git a/dependencies.json b/dependencies.json
@@ -0,0 +1,48 @@
+{
+    "pacman": [
+        "wmctrl",
+        "python-pyqt5",
+        "python-pyqt5-sip",
+        "python-pyqtwebengine"
+    ],
+    "apt": [
+        "wmctrl",
+        "nodejs",
+        "npm",
+        "libglib2.0-dev",
+        "python3-pyqt5",
+        "python3-sip",
+        "python3-pyqt5.qtwebengine",
+        "python3-pygit2"
+    ],
+    "dnf": [
+        "wmctrl",
+        "nodejs",
+        "npm",
+        "glib2-devel",
+        "python3-qt5",
+        "python3-pyqt5-sip",
+        "pyqtwebengine-devel",
+        "python3-pygit2"
+    ],
+    "pkg": [
+        "wmctrl",
+        "node",
+        "npm",
+        "glib",
+        "py38-qt5-sip",
+        "py38-qt5-webengine"
+    ],
+    "pip": {
+        "linux": [
+            "epc",
+            "lxml"
+        ],
+        "win32": [
+            "pyqt5",
+            "pyqt5-sip",
+            "pyqtwebengine",
+            "pygetwindow"
+        ]
+    }
+}
diff --git a/eaf.el b/eaf.el
@@ -7,7 +7,7 @@
 ;; Copyright (C) 2018, Andy Stewart, all rights reserved.
 ;; Created: 2018-06-15 14:10:12
 ;; Version: 0.5
-;; Last-Updated: Tue Aug 10 21:46:49 2021 (-0400)
+;; Last-Updated: Wed Aug 11 16:05:48 2021 (-0400)
 ;;           By: Mingde (Matthew) Zeng
 ;; URL: https://github.com/manateelazycat/emacs-application-framework
 ;; Keywords:
@@ -166,17 +166,16 @@ or `CVS', and any subdirectory that contains a file named `.nosearch'."
     (eaf-add-subdirs-to-load-path)))
 
 (eaf-add-app-dirs-to-load-path)
-
 (require 'eaf-epc)
 
 ;;;###autoload
 (defun eaf-install-dependencies ()
-  "An interactive function that run install-eaf.sh or install-eaf-win32.js or install-eaf-mac.sh for Linux or Windows or macOS respectively."
+  "An interactive function that run install-eaf.py or install-eaf-win32.js or install-eaf-mac.sh for Linux or Windows or macOS respectively."
   (interactive)
   (let* ((eaf-dir (file-name-directory (locate-library "eaf")))
          (default-directory eaf-dir))
     (cond ((eq system-type 'gnu/linux)
-           (shell-command (concat "./install-eaf.sh" "&")))
+           (shell-command (concat "python " "install-eaf.py" "&")))
           ((memq system-type '(cygwin windows-nt ms-dos))
            (shell-command (format "node %s" (concat "install-eaf-win32.js" "&"))))
           ((eq system-type 'darwin)
@@ -1578,24 +1577,26 @@ It currently identifies PDF, videos, images, and mindmap file extensions."
 (advice-add #'dired-find-file :around #'eaf--dired-find-file-advisor)
 (advice-add #'dired-find-alternate-file :around #'eaf--dired-find-file-advisor)
 
-(require 'eaf-browser)
-(require 'eaf-pdf-viewer)
-(require 'eaf-markdown-previewer)
-(require 'eaf-js-video-player)
-(require 'eaf-video-player)
-(require 'eaf-image-viewer)
-(require 'eaf-org-previewer)
-(require 'eaf-mindmap)
-(require 'eaf-mail)
-(require 'eaf-terminal)
-(require 'eaf-camera)
-(require 'eaf-jupyter)
-(require 'eaf-netease-cloud-music)
-(require 'eaf-music-player)
-(require 'eaf-system-monitor)
-(require 'eaf-file-manager)
-(require 'eaf-file-browser)
-(require 'eaf-vue-demo)
+(ignore-errors (require 'eaf-airshare))
+(ignore-errors (require 'eaf-browser))
+(ignore-errors (require 'eaf-camera))
+(ignore-errors (require 'eaf-demo))
+(ignore-errors (require 'eaf-file-browser))
+(ignore-errors (require 'eaf-pdf-viewer))
+(ignore-errors (require 'eaf-markdown-previewer))
+(ignore-errors (require 'eaf-js-video-player))
+(ignore-errors (require 'eaf-video-player))
+(ignore-errors (require 'eaf-image-viewer))
+(ignore-errors (require 'eaf-org-previewer))
+(ignore-errors (require 'eaf-mindmap))
+(ignore-errors (require 'eaf-mail))
+(ignore-errors (require 'eaf-terminal))
+(ignore-errors (require 'eaf-jupyter))
+(ignore-errors (require 'eaf-netease-cloud-music))
+(ignore-errors (require 'eaf-music-player))
+(ignore-errors (require 'eaf-system-monitor))
+(ignore-errors (require 'eaf-file-manager))
+(ignore-errors (require 'eaf-vue-demo))
 
 (provide 'eaf)