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.2.tar.gz (4.0 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.2-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: foldersizes-0.1.2.tar.gz
  • Upload date:
  • Size: 4.0 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.2.tar.gz
Algorithm Hash digest
SHA256 9a2f06d0b595e28cf358c45a5a2b30130ca7b06f704a9ba47828e600d54c467f
MD5 65590e19397a34b446da56e16192dff4
BLAKE2b-256 0eef120b9fa3e743c180f154dd5b22a0825bf5ded2776fbb6713099cff54e5dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: foldersizes-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 99b371abd84dc519c9da4395937626c7e7d7331059e311d63d47aeb5ba229642
MD5 d7d1a4fd3187214f8d7b3c024e134ea9
BLAKE2b-256 e667ec2b8f7a90f817a77c964a3c830ea936f22cc903f9b386caabc1aaeb33ab

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