https://github.com/andreibarsan/powerline-diskspace
A powerline segment for displaying disk utilization.
https://github.com/andreibarsan/powerline-diskspace
linux macos powerline powerline-segment tmux
Last synced: 4 months ago
JSON representation
A powerline segment for displaying disk utilization.
- Host: GitHub
- URL: https://github.com/andreibarsan/powerline-diskspace
- Owner: AndreiBarsan
- License: mit
- Created: 2024-08-25T22:52:58.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-03T22:16:37.000Z (about 1 year ago)
- Last Synced: 2025-09-10T11:18:52.917Z (10 months ago)
- Topics: linux, macos, powerline, powerline-segment, tmux
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
## Development
### Testing
1. Create a test environment, e.g., with venv or conda.
2. Ensure `powerline-status` and `pytest` are installed in your test environment.
3. Run `pytest` inside the `powerline_diskspace` folder.
### Deployment
1. Read [the official guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives) to refresh your memory, if needed.
2. Ensure you have permissions to publish the package. As of 2025-05, only `AndreiBarsan` has it. Please open an issue or email Andrei if you are interested in becoming a maintainer.
3. Bump up the version in `pyproject.toml`.
4. Create a tag for the new version, e.g., `git tag v1.2.3`.
5. Push the tag to GitHub: `git push origin --tags`.
6. Create a new release. This should trigger [the deployment workflow](https://github.com/AndreiBarsan/powerline-diskspace/actions/workflows/python-publish.yml) which will build the package and push it to PyPI.