gotify-tray-customized/README.md

# Gotify Tray


A tray notification application for receiving messages from a [Gotify server](https://github.com/gotify/server).


## Download


[Download the latest release.](https://github.com/seird/gotify-tray/releases/latest)

or, install via pip:
```
$ pip install gotify-tray
```


## Features

- Receive gotify messages in the native notification area.
- Reconnect after wake from sleep or losing network connection.
- Disable notification banners for low priority messages.
- Manually delete received messages.
- Go through a history of all previously received messages.
- Receive missed messages after losing network connection.


## Images

### Notification banners

Windows 10                                         |  KDE
:-------------------------------------------------:|:---------------------------------------------------------:
![notification](https://raw.githubusercontent.com/seird/gotify-tray/master/images/notification.png)           |  ![kde_notification](https://raw.githubusercontent.com/seird/gotify-tray/master/images/kde_notification.png)
![notification](https://raw.githubusercontent.com/seird/gotify-tray/master/images/notification_centre.png)    |  ![kde_notification](https://raw.githubusercontent.com/seird/gotify-tray/master/images/kde_notification_centre.png)

### Main window
![main window](https://raw.githubusercontent.com/seird/gotify-tray/master/images/main_window.png)

### Settings window
![settings](https://raw.githubusercontent.com/seird/gotify-tray/master/images/settings.png)


## Manual Installation

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 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 and install a pip package

- Create the pip package:
    ```
    $ python -m build
    ```

- Install the pip package:
    ```
    $ pip install dist/gotify_tray-0.1.8-py3-none-any.whl
    ```

- Launch:
    ```
    $ gotify-tray
    ```

### Create a deb package

```
$ make build

# or install

$ sudo make install
```


## Requirements

- python >=3.8
- PyQt6
- requests
- websocket-client