Files
gotify-tray-customized/README.md
2022-03-21 19:23:25 +01:00

102 lines
1.8 KiB
Markdown

# Gotify Tray
A tray notification application for receiving messages from a [Gotify server](https://github.com/gotify/server).
<p align="center">
<a href="https://github.com/gotify/logo">
<img height="370px" src="https://raw.githubusercontent.com/gotify/logo/master/gotify-logo.png" />
</a>
</p>
## Download
[Download the latest release.](https://github.com/seird/gotify-tray/releases/latest)
or, install via pip:
```
$ pip install gotify-tray
```
## Supported Platforms
See https://doc.qt.io/qt-6/qsystemtrayicon.html#details
## Manual Install
Get the source and install the requirements:
```
$ git clone https://github.com/seird/gotify-tray.git
$ cd gotify-tray
$ pip install -r requirements.txt
```
### Run from source
```
$ python -m gotify_tray
```
### Create and install a pip package
- Create the pip package:
```
$ python -m build
```
- Install the pip package:
```
$ pip install dist/gotify_tray-0.1.4-py3-none-any.whl
```
- Launch:
```
$ gotify-tray
```
### Create a pyinstaller executable
```
$ pip install pyinstaller
$ pyinstaller gotify-tray.spec
```
An executable is created at `dist/gotify-tray/`.
### Inno setup (Windows)
Create an installer for windows with inno setup from pyinstaller output:
```
$ iscc gotify-tray.iss
```
### Create a deb package
```
$ make build
# or install
$ sudo make install
```
## Images
Windows 10 | KDE
:-------------------------------------------------:|:---------------------------------------------------------:
![notification](images/notification.png) | ![kde_notification](images/kde_notification.png)
![notification](images/notification_centre.png) | ![kde_notification](images/kde_notification_centre.png)
## Requirements
- python >=3.9
- PyQt6
- requests
- websocket-client