# py3status-fbox
Python module to monitor freebox activity in py3status bars
## Prerequisites
This is an i3/py3status module and it uses requests.
## Installation
```console
pip install py3status-fbox
```
## Configuration
Available parameters:
- `refresh_delay` (default: 60s)
- `format` (default: `freebox: ↑ {fmt_rate_up} ↓ {fmt_rate_down}`)
Available format variables:
- `rate_up`: raw upload rate
- `rate_down`: raw download rate
- `fmt_rate_up`: human readable upload rate
- `fmt_rate_down`: human readable download rate
- `bw_up`: raw upload bandwidth
- `bw_down`: raw download bandwidth
- `fmt_bw_up`: human readable upload bandwidth
- `fmtbw_down`: human readable download bandwidth
- `percent_up`: upload bandwidth usage
- `percent_down`: download bandwidth usage
- `time`: time of last update
Example configuration:
```
fbox {
color="#dcedc1"
refresh_delay=10
format = " ↑[\?color=lightgreen {fmt_rate_up}]↓[\?color=lightblue {fmt_rate_down}]"
}
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/patzy/py3status-fbox",
"name": "py3status-fbox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "freebox,monitor,status,i3,py3status",
"author": "patzy",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a3/44/e231bb7d6b290337e64168c48fcaf3f8d8f667860dfbc043b0910e602368/py3status-fbox-0.1.2.tar.gz",
"platform": null,
"description": "# py3status-fbox\n\nPython module to monitor freebox activity in py3status bars\n\n## Prerequisites\n\nThis is an i3/py3status module and it uses requests.\n\n## Installation\n\n```console\npip install py3status-fbox\n```\n\n## Configuration\n\nAvailable parameters:\n- `refresh_delay` (default: 60s)\n- `format` (default: `freebox: \u2191 {fmt_rate_up} \u2193 {fmt_rate_down}`)\n\nAvailable format variables:\n- `rate_up`: raw upload rate\n- `rate_down`: raw download rate\n- `fmt_rate_up`: human readable upload rate\n- `fmt_rate_down`: human readable download rate\n- `bw_up`: raw upload bandwidth\n- `bw_down`: raw download bandwidth\n- `fmt_bw_up`: human readable upload bandwidth\n- `fmtbw_down`: human readable download bandwidth\n- `percent_up`: upload bandwidth usage\n- `percent_down`: download bandwidth usage\n- `time`: time of last update\n\nExample configuration:\n\n```\nfbox {\n color=\"#dcedc1\"\n refresh_delay=10\n format = \"\uf233 \u2191[\\?color=lightgreen {fmt_rate_up}]\u2193[\\?color=lightblue {fmt_rate_down}]\"\n}\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Python module to monitor your freebox in py3status bar",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://gitlab.com/patzy/py3status-fbox"
},
"split_keywords": [
"freebox",
"monitor",
"status",
"i3",
"py3status"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "56a9954422e608b6f715ef645bba997d73de93acb4b131aab5b4fc7dc7f3963e",
"md5": "1f5c277ffadc3276fc5e0d2232e61d32",
"sha256": "182c997389b231a729f36d9df340810a53eb606460594e1b85d2b1c55fa863d4"
},
"downloads": -1,
"filename": "py3status_fbox-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1f5c277ffadc3276fc5e0d2232e61d32",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 1922,
"upload_time": "2023-11-07T21:46:06",
"upload_time_iso_8601": "2023-11-07T21:46:06.274415Z",
"url": "https://files.pythonhosted.org/packages/56/a9/954422e608b6f715ef645bba997d73de93acb4b131aab5b4fc7dc7f3963e/py3status_fbox-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a344e231bb7d6b290337e64168c48fcaf3f8d8f667860dfbc043b0910e602368",
"md5": "179ace9bbc09eeffd97579f9d6f45961",
"sha256": "8435fb15280cad9940188a32d8734d6b1df2b6384508fbf675e911f835eaaf57"
},
"downloads": -1,
"filename": "py3status-fbox-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "179ace9bbc09eeffd97579f9d6f45961",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 1831,
"upload_time": "2023-11-07T21:46:07",
"upload_time_iso_8601": "2023-11-07T21:46:07.580479Z",
"url": "https://files.pythonhosted.org/packages/a3/44/e231bb7d6b290337e64168c48fcaf3f8d8f667860dfbc043b0910e602368/py3status-fbox-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-07 21:46:07",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "patzy",
"gitlab_project": "py3status-fbox",
"lcname": "py3status-fbox"
}