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.4.tar.gz (4.2 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.4-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: foldersizes-0.1.4.tar.gz
  • Upload date:
  • Size: 4.2 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.4.tar.gz
Algorithm Hash digest
SHA256 5b29837ddebaa40fb08f8d8fa558502bdba86abed8e4267faaccb1a0fb1550d3
MD5 ba876ac1363cdf99f672f79c11f6fb43
BLAKE2b-256 7f2ae1cb8cc28ac7bcfb4f4d65b5e43cab1d2e4874c7ee6b78f32636722c2688

See more details on using hashes here.

File details

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

File metadata

  • Download URL: foldersizes-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.3 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ff8f52e2e1d56115373753a4669feca583a6adfa69a6dea5f169246536048b4c
MD5 9aa49c6e8387cf761e742ec5ffe42f31
BLAKE2b-256 04bf764ea8775b06fcca2cd5574d666f7f2f2796b09c51959a24b2f2dfcf573b

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