| Name | powerline-diskspace JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | None |
| Summary | A Powerline segment for displaying local disk utilization. |
| upload_time | 2024-08-26 02:41:37 |
| maintainer | None |
| docs_url | None |
| author | Andrei Bârsan |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Powerline Disk Utilization Indicator
A tiny [Powerline](https://github.com/powerline/powerline) segment I wrote (originally for `tmux`) to show me disk space utilization in its status line. This component does not work natively with `tmux` - if you just want a native tmux-specific component, check out [tmux-df](https://github.com/tassaron/tmux-df).
Here is a screenshot of this segment in action:
The root `/` is red because, unlike `/cache`, it's over the `critical_threshold` I set to 40% for this example.
In this case, the relevant part of the powerline config (`cat ~/.config/powerline/themes/tmux/default.json`) is:
```json
{
"segments": {
"right": [
{
"function": "powerline_diskspace.diskspace.Diskspace",
"priority": 30,
"args": {
"format": "{mounted_on} @ {capacity:.0f}%",
"mount_ignore_pattern": "(/snap|/dev|/run|/boot|/sys/fs)",
"show_when_used_over_percent": {
"/": 20,
},
"critical_threshold": 40
}
}
]
}
}
```
(Other plug-ins featured in the screenshot, like `uptime`, are not shown.)
## Getting Started
System requirements:
* Linux (macOS support is only partial)
* Python 3.8+
* [Powerline](https://github.com/powerline/powerline) set up and in use (code only tested in tmux, but other places like `vim` should work to)
Installation steps:
1. Install the Python package: `pip install powerline-diskspace`.
2. Update your `powerline` (not `tmux`!) config following the example above.
3. Restart the Powerline daemon: `powerline-daemon --replace`
If you have any questions or encounter issues setting up, please don't hesitate to open up an issue on GitHub!
## Customization
There are many ways to customize your output. Please refer to the `__call__` method in `diskspace.py`, which is essentially the "main function" of the segment for more documentation.
Raw data
{
"_id": null,
"home_page": null,
"name": "powerline-diskspace",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Andrei B\u00e2rsan",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e1/fb/802f01e69daea58ad4c72d722f6e703af0f99a922e8869bb8b0254cde69b/powerline_diskspace-0.1.2.tar.gz",
"platform": null,
"description": "# Powerline Disk Utilization Indicator\n\nA tiny [Powerline](https://github.com/powerline/powerline) segment I wrote (originally for `tmux`) to show me disk space utilization in its status line. This component does not work natively with `tmux` - if you just want a native tmux-specific component, check out [tmux-df](https://github.com/tassaron/tmux-df).\n\nHere is a screenshot of this segment in action:\n\n\n\nThe root `/` is red because, unlike `/cache`, it's over the `critical_threshold` I set to 40% for this example.\n\nIn this case, the relevant part of the powerline config (`cat ~/.config/powerline/themes/tmux/default.json`) is:\n\n```json\n{\n\"segments\": {\n \"right\": [\n {\n \"function\": \"powerline_diskspace.diskspace.Diskspace\",\n \"priority\": 30,\n \"args\": {\n \"format\": \"{mounted_on} @ {capacity:.0f}%\",\n \"mount_ignore_pattern\": \"(/snap|/dev|/run|/boot|/sys/fs)\",\n \"show_when_used_over_percent\": {\n \"/\": 20,\n },\n \"critical_threshold\": 40\n }\n }\n ]\n}\n}\n```\n\n(Other plug-ins featured in the screenshot, like `uptime`, are not shown.)\n\n## Getting Started\n\nSystem requirements:\n * Linux (macOS support is only partial)\n * Python 3.8+\n * [Powerline](https://github.com/powerline/powerline) set up and in use (code only tested in tmux, but other places like `vim` should work to)\n\nInstallation steps:\n\n1. Install the Python package: `pip install powerline-diskspace`.\n2. Update your `powerline` (not `tmux`!) config following the example above.\n3. Restart the Powerline daemon: `powerline-daemon --replace`\n\nIf you have any questions or encounter issues setting up, please don't hesitate to open up an issue on GitHub!\n\n\n## Customization\n\nThere are many ways to customize your output. Please refer to the `__call__` method in `diskspace.py`, which is essentially the \"main function\" of the segment for more documentation.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Powerline segment for displaying local disk utilization.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/AndreiBarsan/powerline-diskspace",
"Issues": "https://github.com/AndreiBarsan/powerline-diskspace/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7a313ec1d739440903eb8e96a0ff0ce87b35db6ace96abc39f6b480a111b3ab6",
"md5": "19bd1f74c8daad65bb0d6b441cf4f5a2",
"sha256": "78290b80cf7d6d9fc20d5c6f3f17cf1ea66ed93b1a11fc61526dacf2434ac13c"
},
"downloads": -1,
"filename": "powerline_diskspace-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "19bd1f74c8daad65bb0d6b441cf4f5a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7133,
"upload_time": "2024-08-26T02:41:35",
"upload_time_iso_8601": "2024-08-26T02:41:35.177421Z",
"url": "https://files.pythonhosted.org/packages/7a/31/3ec1d739440903eb8e96a0ff0ce87b35db6ace96abc39f6b480a111b3ab6/powerline_diskspace-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1fb802f01e69daea58ad4c72d722f6e703af0f99a922e8869bb8b0254cde69b",
"md5": "b5ebbf4a1352af4ce1b667d70a5baef1",
"sha256": "7657b341d2d4528c7c29c70c6af240d6369eccf6df9bd51f80e52d028f972927"
},
"downloads": -1,
"filename": "powerline_diskspace-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "b5ebbf4a1352af4ce1b667d70a5baef1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8895380,
"upload_time": "2024-08-26T02:41:37",
"upload_time_iso_8601": "2024-08-26T02:41:37.181827Z",
"url": "https://files.pythonhosted.org/packages/e1/fb/802f01e69daea58ad4c72d722f6e703af0f99a922e8869bb8b0254cde69b/powerline_diskspace-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 02:41:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AndreiBarsan",
"github_project": "powerline-diskspace",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "powerline-diskspace"
}
