polybar-diskspace-module

A polybar Module which shows disk space in 4 different modes.

Table of Contents

• Introduction
• Getting started
  • Dependencies
  • Installing Dependency
  • Configuration
  • Installation
• License

Introduction

A polybar Module which shows disk space in 4 different modes.

Getting Started

Dependencies

• python
• pip
• vizex - vizex is the terminal program for the UNIX/Linux systems which helps the user to visualize the disk space usage for every partition and media on the user's machine.
  
• Nerd Fonts

Installing Dependencies

Vizex

pip

vizex can be installed through your terminal and requires Python >= 3.9 and the pip package manager. Here's how to set up Python on your machine.

If you don't have PyPackage Index (PyPI or just pip) installed, Here's the guide on how to install it. Install vizex with the following command:

pip install vizex

If you already have vizex install you'll need to upgrade it:

pip install vizex --upgrade

If you encounter any problems during installation, know that some vizex dependencies require a Python 3 development package on Linux and you need to set up that manually.

For Debian and other derived systems (Ubuntu, Mint, Kali, etc.) you can install this with the following command:

sudo apt-get install python3-dev

For Red Hat derived systems (Fedora, RHEL, CentOS, etc.) you can install this with the following command:

sudo yum install python3-devel

AUR

vizex is available as a package on the AUR (Arch user repository), distributions with AUR support may install directly from the command line using their favorite pacman helper.

Example using yay:

yay -S vizex

Nerd Fonts

Installation Instructions for Nerd Fonts Provided on their Github. NOTE: Arch Users can install using AUR

yay -S nerd-fonts-*

Write desired fonts in place of *

Configuration

disk module contains 4 different functions
Below given is the default module

[module/disk]
type = custom/script
; Script
; exec = /path/to/script <<< display_method
; display_methods can be used_total , free , used , all
exec = $HOME/.config/polybar/scripts/diskspace/diskspace.sh <<< used_total
; Update interval
interval = 600
; Label
label            = %{T2} %output%
label-foreground = ${colors.foreground}
label-padding    = 1 

The default config(used_total) shows gives output like this

free config - It shows free space available in the disk.

used config - It shows used space in the disk.

all config - It shows all info i.e Total disk storage, used and available.

Installation

1. Clone the repository

https://github.com/iamcodernitesh/polybar-diskspace-module.git

2. Give the script sudo permissions

chmod 755 install.sh

3. Cd into the directory

cd polybar-diskspace-module

5. Run the script

./install.sh

Follow Me on