{"id":13732648,"url":"https://github.com/crabvk/bar-gmail","last_synced_at":"2025-08-31T10:34:24.551Z","repository":{"id":50259407,"uuid":"100807492","full_name":"crabvk/bar-gmail","owner":"crabvk","description":"A Polybar module to show unread messages from Gmail","archived":false,"fork":false,"pushed_at":"2025-01-11T14:57:53.000Z","size":100,"stargazers_count":91,"open_issues_count":0,"forks_count":13,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-30T04:04:25.920Z","etag":null,"topics":["gmail","polybar"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crabvk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-19T16:38:46.000Z","updated_at":"2025-08-26T18:49:55.000Z","dependencies_parsed_at":"2023-09-23T08:34:55.102Z","dependency_job_id":"d9e78fc9-ec47-40fe-bbb4-2810fc7a4663","html_url":"https://github.com/crabvk/bar-gmail","commit_stats":null,"previous_names":["crabvk/bar-gmail","crabvk/polybar-gmail"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/crabvk/bar-gmail","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crabvk%2Fbar-gmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crabvk%2Fbar-gmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crabvk%2Fbar-gmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crabvk%2Fbar-gmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crabvk","download_url":"https://codeload.github.com/crabvk/bar-gmail/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crabvk%2Fbar-gmail/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272971396,"owners_count":25024093,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gmail","polybar"],"created_at":"2024-08-03T03:00:30.874Z","updated_at":"2025-08-31T10:34:24.508Z","avatar_url":"https://github.com/crabvk.png","language":"Python","funding_links":[],"categories":["Plugins","Python"],"sub_categories":[],"readme":"# Bar Gmail\n\n![preview](https://github.com/crabvk/polybar-gmail/raw/master/preview.png)\n\nGet notifications and unread messages count from Gmail (Waybar/Polybar module).\n\n## Requirements\n\n* Font Awesome: default badge \n* Libcanberra: notification sound (optional).\n\nTo display notifications you must have a [notification daemon](https://wiki.archlinux.org/title/Desktop_notifications#Notification_servers) running on your system.\n\n## Installation\n\nUse one of the following methods.\n\n### AUR package on ArchLinux and derivatives\n\nhttps://aur.archlinux.org/packages/bar-gmail/\n\n### With pip from pypi.org\n\n```sh\npip install --user bar-gmail\n~/.local/bin/bar-gmail\n```\n\nDepending on your system you may also need to add the `--break-system-packages` flag.\n\n### With pip from git repo\n\n```sh\ngit clone https://github.com/crabvk/bar-gmail.git\ncd bar-gmail\ngit describe --abbrev=0 --tags # Get latest tag.\ngit checkoug LATEST_TAG\npip install -e .\n~/.local/bin/bar-gmail\n```\n\n## Usage\n\nFirst, you need to authenticate the client:\n\n```sh\nbar-gmail auth\n```\n\nThen just run `bar-gmail` or `bar-gmail --format polybar` periodically to get unread messages count and new message notifications.\n\nCredentials and session are stored in *~/.cache/bar-gmail*.\n\n## Waybar config example\n\n*~/.config/waybar/config*\n\n```json\n\"modules-right\": {\n    \"custom/gmail\"\n}\n\n\"custom/gmail\": {\n    \"exec\": \"bar-gmail\",\n    \"return-type\": \"json\",\n    \"interval\": 10,\n    \"tooltip\": false,\n    \"on-click\": \"xdg-open https://mail.google.com/mail/u/0/#inbox\"\n}\n```\n\n*~/.config/waybar/style.css*\n\n```css\n#custom-gmail.unread {\n    color: white;\n}\n#custom-gmail.inaccurate {\n    color: darkorange;\n}\n#custom-gmail.error {\n    color: darkred;\n}\n```\n\n## Polybar config example\n\n```ini\nmodules-right = gmail\n...\n[module/gmail]\ntype = custom/script\nexec = bar-gmail -f polybar\ninterval = 10\nclick-left = xdg-open https://mail.google.com/mail/u/0/#inbox\n```\n\n## Script arguments\n\nSee `bar-gmail --help` for the full list of available subcommands and command arguments.\n\nPossible values for `-s`, `--sound` is obtained with:\n\n```shell\nls /usr/share/sounds/freedesktop/stereo/ | cut -d. -f1\n```\n\nfor example `bar-gmail --sound message-new-instant`.\n\nIf you have several mails you can specify the `credentials.json` file with the `--credentials \u003cpath\u003e` flag.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrabvk%2Fbar-gmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrabvk%2Fbar-gmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrabvk%2Fbar-gmail/lists"}