Skip to main content

A simple script to list folder sizes

Project description

FolderSizes Project

Description

FolderSizes is a Python package that provides a command-line interface for displaying the sizes of directories and files in a human-readable format. It allows users to easily visualize the space usage of their file system.

Features

  • Recursively calculates the total size of directories.
  • Displays sizes in both human-readable format and in bytes.
  • Optionally includes files in the size listing.
  • Sorts entries by size, largest first.

Installation

To install FolderSizes, you can use pip. First, ensure you have Python and pip installed on your system. Then, run the following command:

pip install FolderSizes

Usage

After installation, you can use the foldersizes command in your terminal. Here are some examples of how to use it:

  1. To display sizes of subdirectories in the current directory:

    foldersizes
    
  2. To display sizes in a human-readable format:

    foldersizes -H
    
  3. To include files in the listing:

    foldersizes --files
    
  4. To sort entries by size, largest first:

    foldersizes -s
    

Requirements

This package requires the click library. It will be installed automatically when you install FolderSizes.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any suggestions or improvements.

Author

Carter Struck

Acknowledgments

  • Thanks to the contributors of the click library for making command-line interfaces easier to implement.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foldersizes-0.1.1.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

foldersizes-0.1.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file foldersizes-0.1.1.tar.gz.

File metadata

  • Download URL: foldersizes-0.1.1.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for foldersizes-0.1.1.tar.gz
Algorithm Hash digest
SHA256 21735ba53f00d9976d0cbdd52953281ed9dbd9aad367b09b9ce575a489cc6f0f
MD5 e7ce782ac3646527e612486e4c9bcab4
BLAKE2b-256 4336bfea554345fda439956a0e4b35b3b592b5d42f2d2efeaeb17aafb32a4079

See more details on using hashes here.

File details

Details for the file foldersizes-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: foldersizes-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for foldersizes-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a83eea2f3a35b67b3b892ae05c042825b534e882aa5a142f63b33b1d646a2a3e
MD5 db9f934b0477e5b1f7275b45d53e909a
BLAKE2b-256 c75d9829bde4a84cec57ea40746f516f6eb973502c020631aa827e4bf78ef99e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page