Suggestion: Add an entrypoint and/or scripts for command-line use

Open
#184 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
cli

Research direction

Start by inspecting the existing naturalsize API and how the package currently exposes modules or entry points. Compare the requested naturalsize command and python -m humanize examples, including binary, format, and piped-input behavior; done means a documented command-line path supports the agreed scope.

Written by the indexing model from the issue text.

Description

Thank you for your great project!

Google always guides me to https://stackoverflow.com/a/15485265, which suggests humanize.naturalsize(). I'm ok to type in ipython, and copy & paste import humanize and humanize.naturalsize().

But it'd be more than great if this small task could be simplified in something like these ways.

$ naturalsize 8589934592
8.6 GB
$ naturalsize --binary 8589934592
8.0 GiB
$ echo 8589934592 | python -m humanize naturalsize --format "%.3f"
8.590 GB

There are tools such as numfmt, but pip install is easier for me as a Windows user. :)

I'd open a PR if I found some time for this. But I can't promise my contribution. So, I'm filing just an idea here.

Dominant language
Python
Stars
757
Forks
148
Avg merge
6d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python-humanize/humanize

All issues in python-humanize/humanize

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.