salindersidhu / Diskmap

A disk / drive space visualization utility

Diskmap

Table of Contents

• Overview
  • Features
  • Supported Platforms
• Development
  • Prerequisites
  • Setup
  • Running
  • Contributing
• Codebase
  • Structure

Overview:

Diskmap is a hard drive space visualization utility. This program displays all the files and folders within a selected location as a rectangular map where each rectangle is proportional to the size of the file it represents. Each rectangular tile on the map is selectable; to select it simply hover over the tile with your mouse. Right click on a selected tile to bring up a popup menu containing options to rename, move and delete the selected file. For optimal viewing, it is recommended to use the application in full screen mode.

Features:

• Graphical visualization of files and folders
• Rename, move and delete files in the visualizer
• Save screenshots of the visualization

Supported Platforms:

• Windows 10, Mac OS X and Linux based distributions

Development

Information describing how to install and configure all the required tools to begin development.

Prerequisites:

Ensure that you have the following installed and configured any environment variables.

• Python
  • Version 3.7.5+

Setup:

You will need to setup a python virtual environment and install the project's dependencies.

1. Skip this step if you're using Windows. If you're using Mac or Linux, you may need to install pip and virtualenv first:

sudo apt-get install python3-pip
sudo pip3 install virtualenv

2. Navigate to your Diskmap repo and create a new virtual environment with the following command:

# Windows
python -m venv venv

# Mac or Linux
virtualenv venv

3. Enable your virtual environment with the following command:

# Windows
source venv/Scripts/activate

# Mac or Linux
source venv/bin/activate

Your command line will be prefixed with (venv) which indicates that the virtual environment is enabled.

4. Install the project's dependencies with the following command:

pip install -r requirements.txt

If you have recently pulled changes from a remote branch, you should re-run the above command to obtain any new dependencies that may have been added to the project.

Running:

1. Enable your virtual environment with the following command:

# Windows
source venv/Scripts/activate

# Mac or Linux
source venv/bin/activate

2. Launch the visualizer with the following command:

python diskmap.py

Contributing

Diskmap welcomes contributions from anyone and everyone. Please see our contributing guide for more info.

Codebase

Information describing the software architecture and how to maintain it while adding additional functionality.

Structure

.
├── ...
├── assets                      # Assets
│    ├── icon.svg               # Diskmap window icon
│    └── ...
├── treemap                     # Python Treemap package and it's node data structures
│   ├── __init__.py             # Package main file generates a recursive treemap of the file structure
│   ├── dirnode.py              # Directory node data structure
│   ├── filenode.py             # File node data structure
│   ├── node.py                 # Node data structure
│   └── ...
├── diskmap.py                  # Main application
├── guiwindow.py                # PyQt5 GUI window setup and config
├── tileframe.py                # PyQt5 frame for rending the treemap
├── requirements.txt            # Dependencies to install with pip
└── ...