https://github.com/nicciniamh/spacehog

Python script to find top diskspace hogs
https://github.com/nicciniamh/spacehog

cli disk-management macos python3 systemadm unix

Last synced: about 1 month ago
JSON representation

Python script to find top diskspace hogs

• Host: GitHub
• URL: https://github.com/nicciniamh/spacehog
• Owner: nicciniamh
• License: gpl-3.0
• Created: 2020-05-15T05:11:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-11T05:16:08.000Z (over 4 years ago)
• Last Synced: 2023-10-20T22:03:38.324Z (about 1 year ago)
• Topics: cli, disk-management, macos, python3, systemadm, unix
• Language: Python
• Size: 2.29 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        



# Spacehog

Python Script to find disk space 'hogs'

## Requirements

* Python3

* *psutils (pip3 install psutils)

## Installation

To install follow these steps:

      git clone https://github.com/nicciniamh/spacehog.git

      cp spacehog/spacehog ~/bin # or other directory on PATH

      chmod 755 ~bin/spacehog

      cp spacehog.ini ~/bin # This file must be present.

      pip3 install psutils

## Usage

 *spacehog* [-h] [--config] [--count number] [--ignore filename][--mounted] [--showfs] [--output filename] [--quiet] [dir] ... 

 

### Program arguments

*--config* Full path to a different ini file.

*--count*  number of directories to display (may be less if there arent that many)

*--ignore* file with list of regular expressions (or plain text) of paths to ignore

 		

*--mounted* scan mounted filesystems. Default is to not traverse mounted file systems.

*--output* filename. Write report to *filename*, implies --quiet as well.

*--quiet* prevents scanning status messages.

*--showfs* Show filesystem information. 

*dir ..* one or more directories to scan. If not specified, current workng directory is used.

# Description

*Spacehog* attempts to located files and directories under *dir* and calculate, based on file size, the usage and reports the top *count* directories. Multiple directories may be specified.

To create a report, use the --output file.ext option to write a report to file.ext. Reports are written with a timestamp in the banner.

To include filesystem information (free space, total space and percent free) use the --showfs option.  

This program is generally pretty quick depending on disk type and processor speed. 

## Excluding Directories

By default, *spacehog* looks for a file called .spacehog.ignore which is one or more lines of regular expressions, representing directories to exclude. To override this file, specify --ignore and the path of the ignore list. This file is either an absolute path or relative to the path being examined. If '--ignore none' is used, no ignore list will be used and all directories will be examined.

## Mounted File Systems

By default, *spacehog* will not traverse mounted filesystems. This is done using *os.path.ismount* and may fail on some systems (notably *MacOS* where some Volumes do not appear as mounts). To force *spacehog* to follow these mounts, use the --mounted flag. This may or may not work with *NTFS* (Friends don't let friends use NTFS) volume mounted on a particular directory. 

## Quiet Mode

By default, *spacehog* displays it's progress/status when scanning directories. To prevent this, use gthe --quiet option. This is useful if you want a report generrated. 

## Customizing

The file, spacehog.ini, contains message texts and tokens to be replaced at runtime. These texts can be changed to customize the texts or even change to another language.

## Examples

`spacehog --count=5 ~/Code` counts the top five directories in *~/Code*

`spacehog --count=20 --output=~/top20,txt /home/nicci` Produces a report of the top 20 disk hogs in */home/nicci*

`spacehog --ignore /home/nicci/ignorethese.txt /usr` Counts the top 10 disk consumers in /usr, ignoring paths in */home/nicci/ignorethese.txt*

### Sample Output

      Report Run: 06:43, 21 May, 2020

      Top 10 Directories in /Volumes/Extra/Users/nicci

      --- -- ----------- -- --------------------------

         Size Path

      ------- --------------

      325.3Gb Pictures

       36.4Gb VirtualBox VMs

       19.5Gb Library

       12.9Gb Downloads

       10.2Gb pdbak

        1.4Gb Dropbox

        1.2Gb Music

        1.2Gb Tools

      489.7Mb DAW

      449.1Mb Documents

	409.1Gb bytes in 10 directories (3855 files)

      File System Information

      ---- ------ -----------

      	/dev/disk1s4:	156.3Gb bytes total, 45.2Gb bytes free (28% free)

		dir(s): /Volumes/Extra/Users/nicci

Copyright © 2020 Nicole Stevens. Code may be freely used. Please keep my copyright intact. 

For license see LICENSE.