|
|
@@ -1,14 +1,79 @@
|
|
1
|
1
|
# OctoTray Linux Qt client
|
|
2
|
2
|
|
|
3
|
|
-Simple Python Qt Linux client for OctoPrint. Install on Arch Linux like this:
|
|
|
3
|
+This is a simple Qt application living in the system tray.
|
|
|
4
|
+It allows remote-control and observation of 3D printers running OctoPrint.
|
|
|
5
|
+For the implementation it is using PyQt5.
|
|
|
6
|
+Automatic builds are provided for Linux, Windows and macOS.
|
|
4
|
7
|
|
|
5
|
|
- makepkg
|
|
6
|
|
- sudo pacman -U octotray-0.2-1-any.pkg.tar.xz
|
|
|
8
|
+For more [take a look at OctoTray on my website](https://www.xythobuz.de/octotray.html).
|
|
7
|
9
|
|
|
8
|
|
-Or on all other linux distros:
|
|
|
10
|
+## Building
|
|
9
|
11
|
|
|
10
|
|
- sudo cp octotray /usr/bin/octotray
|
|
11
|
|
- sudo cp octotray_icon.png /usr/share/pixmaps/octotray_icon.png
|
|
12
|
|
- sudo cp de.xythobuz.octotray.desktop /usr/share/applications/de.xythobuz.octotray.desktop
|
|
|
12
|
+You have different options of building and running OctoTray:
|
|
|
13
|
+
|
|
|
14
|
+### From Source
|
|
|
15
|
+
|
|
|
16
|
+OctoTray can simply be run from the checked out repository, if all dependencies are installed.
|
|
|
17
|
+
|
|
|
18
|
+ ./src/octotray.py
|
|
|
19
|
+
|
|
|
20
|
+For this you need Python 3 as well as PyQt5.
|
|
|
21
|
+
|
|
|
22
|
+### Pre-Built Windows Binary
|
|
|
23
|
+
|
|
|
24
|
+To run OctoTray on MS Windows without much hassle, a pre-built binary is provided, made with [PyInstaller](https://pyinstaller.readthedocs.io) and GitHub Actions.
|
|
|
25
|
+
|
|
|
26
|
+Simply download the latest version from the GitHub Actions tab, in the artifacts of the most recent build.
|
|
|
27
|
+You need to be logged in for this!
|
|
|
28
|
+
|
|
|
29
|
+You can also find binaries for each release on GitHub.
|
|
|
30
|
+
|
|
|
31
|
+To create your own binary from source, simply run:
|
|
|
32
|
+
|
|
|
33
|
+ bash build_win.sh
|
|
|
34
|
+
|
|
|
35
|
+The resulting executable will be in 'build/dist/win' as well as 'build/dist/OctoTray_Win.zip'.
|
|
|
36
|
+
|
|
|
37
|
+### Pre-Build macOS Application Bundle
|
|
|
38
|
+
|
|
|
39
|
+For Mac users, a pre-built application bundle is provided, made with [py2app](https://py2app.readthedocs.io) and GitHub Actions.
|
|
|
40
|
+
|
|
|
41
|
+Simply download the latest version from the GitHub Actions tab, in the artifacts of the most recent build.
|
|
|
42
|
+You need to be logged in for this!
|
|
|
43
|
+
|
|
|
44
|
+You can also find binaries for each release on GitHub.
|
|
|
45
|
+
|
|
|
46
|
+To create your own bundle from source, simply run:
|
|
|
47
|
+
|
|
|
48
|
+ ./build_mac.sh
|
|
|
49
|
+
|
|
|
50
|
+The generated bundle will then be in 'build/mac/dist/OctoTray.app' as well as 'build/dist/OctoTray_Mac.zip'.
|
|
|
51
|
+
|
|
|
52
|
+### Arch Linux Package
|
|
|
53
|
+
|
|
|
54
|
+Create and install an Arch Linux package like this:
|
|
|
55
|
+
|
|
|
56
|
+ ./build_arch.sh
|
|
|
57
|
+ sudo pacman -U dist/octotray-0.3-1-any.pkg.tar.xz
|
|
13
|
58
|
|
|
14
|
59
|
Then run it from your desktop environment menu or even add it to the autostart there.
|
|
|
60
|
+
|
|
|
61
|
+### Manual Installation on Linux
|
|
|
62
|
+
|
|
|
63
|
+You can also install the required files manually, which should work for most other Linux distribution and Unices:
|
|
|
64
|
+
|
|
|
65
|
+ sudo ./build_unix.sh
|
|
|
66
|
+
|
|
|
67
|
+After logging out and back in, you should find OctoTray in the menu of your graphical desktop environment.
|
|
|
68
|
+Take a look at the script to see exactly what is installed where.
|
|
|
69
|
+
|
|
|
70
|
+### Pre-Built Linux Binary
|
|
|
71
|
+
|
|
|
72
|
+For completeness, a single pre-build Linux binary is also provided on GitHub, made with PyInstaller like the Windows build.
|
|
|
73
|
+It is however not recommended for productive use.
|
|
|
74
|
+
|
|
|
75
|
+To create it yourself, simply run:
|
|
|
76
|
+
|
|
|
77
|
+ ./build_linux.sh
|
|
|
78
|
+
|
|
|
79
|
+The resulting binary will be in 'build/linux/dist' as well as 'build/dist/OctoTray_Linux.zip'.
|
Thomas Buck
3 years ago