Skip to content

Visualize disk space and disk usage in your UNIX\Linux terminal

License

Notifications You must be signed in to change notification settings

christian-stephen/vizex

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation




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. vizex is highly customizable and can fit any user's taste and preferences.

Installation

pip

vizex can be installed through your terminal and requires Python >= 3.7 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 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

How it Works

After installing run the program with a single command vizex in your terminal. This will graphically display disk space and usage:

vizex

demo

But the best part is that you can modify the colors and style of the display to your preferences with the following commands. For the example above command has excluded two partitions. You can also do give the following options:

-d --header <color>
-s --style <attribute>
-t --text <color>
-g --graph <color>

Display additional details, like fstype and mount point, for each partition:

vizex --details

details-img

If you are interested in visualizing a specific path run with the following command:

vizex --path </full/path>

You can also exclude any combination of partitions/disks with multiple -X or for verbose --exclude option:

vizex -X <PartitionName1> -X <PartitionName2> ...

For a full list of the available options please check:

vizex --help

If you want to contribute to the project you are more than a welcome! But first, make sure all the tests run after you fork the project and before the pull request. First, run the access.py, that way tests folder will obtain a path to the src folder and you can run all the tests.

File Structure

.
├── LICENSE
├── README.md
├── requirements.txt
├── setup.py
├── src/
│   ├── charts.py
│   ├── cli.py
│   ├── disks.py
│   ├── pkg/
│   │   └── __init__.py
│   └── tools.py
└── tests/
    ├── access.py
    ├── test_charts.py
    ├── test_cli.py
    ├── test_disk.py
    └── test_tools.py

Release History

  • v1.3.5:

    • Major refactoring
    • Now charts can print string data
    • Options class is separated with all the correct getters and setters
  • v1.3.2:

    • Refactored module disks.py
    • Unit Tests created
    • Set up the color for all the text
    • Updated docstrings
  • v1.1.0:

    • Displayes media and network partitions
    • Print all the partitions with --every cmd
    • Print additional (fstype and mount point) with --details

Special Thanks to the Contributors!


Follow Me on Social Media

twitter linkedin github

Repo is distributed under the MIT license. Please see the LICENSE for more information.

About

Visualize disk space and disk usage in your UNIX\Linux terminal

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%