Skip to main content

Get notifications and unread messages count from Gmail (Waybar/Polybar module)

Project description

Bar Gmail

preview

Get notifications and unread messages count from Gmail (Waybar/Polybar module).

Dependencies

  • Font Awesome: default badge 
  • Libnotify: new email notifications, can be disabled with --no-notify flag.
  • Libcanberra: notification sound (optional).

To display notifications you must have a notification daemon running on your system.

Installation

Use one of the following methods.

AUR package on ArchLinux and derivatives

https://aur.archlinux.org/packages/bar-gmail/

With pip from pypi.org

pip install --user bar-gmail
~/.local/bin/bar-gmail

Depending on your system you may also need to add the --break-system-packages flag.

With pip from git repo

git clone https://github.com/crabvk/bar-gmail.git
cd bar-gmail
git describe --abbrev=0 --tags # Get latest tag.
git checkoug LATEST_TAG
pip install -e .
~/.local/bin/bar-gmail

Usage

First, you need to authenticate the client:

bar-gmail auth

Then just run bar-gmail or bar-gmail --format polybar periodically to get unread messages count and new message notifications. Credentials and session are stored in ~/.cache/bar-gmail.

Waybar config example

~/.config/waybar/config

"modules-right": {
    "custom/gmail"
}

"custom/gmail": {
    "exec": "bar-gmail",
    "return-type": "json",
    "interval": 10,
    "tooltip": false,
    "on-click": "xdg-open https://mail.google.com/mail/u/0/#inbox"
}

~/.config/waybar/style.css

#custom-gmail.unread {
    color: white;
}
#custom-gmail.inaccurate {
    color: darkorange;
}
#custom-gmail.error {
    color: darkred;
}

Polybar config example

modules-right = gmail
...
[module/gmail]
type = custom/script
exec = bar-gmail -f polybar
interval = 10
click-left = xdg-open https://mail.google.com/mail/u/0/#inbox

Script arguments

See bar-gmail --help for the full list of available subcommands and command arguments. Possible values for -s, --sound can be obtained with:

ls /usr/share/sounds/freedesktop/stereo/ | cut -d. -f1

for example bar-gmail --sound message-new-instant.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bar_gmail-1.0.2.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

bar_gmail-1.0.2-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file bar_gmail-1.0.2.tar.gz.

File metadata

  • Download URL: bar_gmail-1.0.2.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/6.5.4-zen2-1-zen

File hashes

Hashes for bar_gmail-1.0.2.tar.gz
Algorithm Hash digest
SHA256 b281c7e6931754ab9c3b8c9cf742be2a82cf38fa69888b1f3cb27eb6c61db933
MD5 4ff0b573d490fe3b217bceb1f19d03cf
BLAKE2b-256 04174d607159697f00dcde40f3e2f073e7c427fc253c9898aa0712b751d0bf14

See more details on using hashes here.

File details

Details for the file bar_gmail-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: bar_gmail-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Linux/6.5.4-zen2-1-zen

File hashes

Hashes for bar_gmail-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 52a1a5163b2952671bf75a1307ebcc9e6c5d40602560d2e85a0f396b6bd1e9c7
MD5 e31f111c7225fdbe45cfb6b42bb1e15c
BLAKE2b-256 861d5ccbc897587a77ea0720c990128ebc81452f5c5dbef3497c388f91e155c8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page