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.5.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.5-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: foldersizes-0.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 f69cf7cfa189009a333c83b203d3ffbd23408e2d8ffa24e8635a0e47fb24bf03
MD5 d33601b6a860802aa8dfc9716e1229c8
BLAKE2b-256 b3bdd6a0d105fcdfbb32c463fce76008ee303d74257cd4e34f836ab941c5d2a1

See more details on using hashes here.

File details

Details for the file FolderSizes-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: FolderSizes-0.1.5-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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 bf90a179436098a066b88a65b9346f2e713fdb3d8cacc786e3a965bec35dac68
MD5 55f04a053b5a82fa0bbe2846277c1de3
BLAKE2b-256 0b899195c1686c0133562e1a134776b0b489aadab5e8338b0dd81095947be528

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