https://github.com/chayandatta/humanreadableformatter.jl
Humane Units and make them Readable
https://github.com/chayandatta/humanreadableformatter.jl
julia package
Last synced: 11 days ago
JSON representation
Humane Units and make them Readable
- Host: GitHub
- URL: https://github.com/chayandatta/humanreadableformatter.jl
- Owner: chayandatta
- License: mit
- Created: 2024-11-05T10:47:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-07T11:32:16.000Z (over 1 year ago)
- Last Synced: 2025-01-06T00:42:40.384Z (over 1 year ago)
- Topics: julia, package
- Language: Julia
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HumanReadableFormatter.jl
`HumanReadableFormatter.jl` is a Julia package that offers straightforward functions for converting data sizes (and upcoming, time) into easy-to-read, human-friendly formats. Whether you’re dealing with bytes or seconds, `HumanReadableFormatter.jl` simplifies your data into comprehensible units, so you can focus on what matters.
## Installation
To install `HumanReadableFormatter.jl`, open your Julia REPL, press `]` to enter the package manager, and then run:
```julia
add HumanReadableFormatter
```
## Usage
### Data Size Conversion
The package provides functions that convert data sizes (in bytes) into human-readable formats, automatically using appropriate units (KB, MB, GB, etc.).
#### Example
```julia
julia> using HumanReadableFormatter
julia> datasize(1000, format=:decimal)
"1k"
julia> datasize(1024)
"1KB"
julia> datasize(1024, format=:jdec)
"1KB"
julia> datasize(1024, format=:binary)
"1KiB"
```
*`datasize` automatically converts the byte size to the best-fitting unit, rounding for simplicity and ease of understanding.*
### Time Conversion (Upcoming)
The next version of `HumanReadableFormatter.jl` will include time conversion functions, making it just as easy to format time intervals in a human-friendly way."
## Function Reference
### `datasize(bytes::Int; format::Symbol=:si) -> String`
Converts an integer representing bytes into a more readable string format, choosing the best-fitting unit (e.g., KB, MB, GB) based on the input size.
- **Parameters**:
- `bytes`: An integer representing the size in bytes.
- `format` (optional): Name for the format (default: SI).
- **Returns**: A string with the human-readable format of the data size.
### Future Functions (Time Conversion)
Time conversion functions will soon be available to handle time durations in a similar human-readable format.
## Contributing
Contributions are welcome! If you’d like to contribute to `HumanReadableFormatter.jl`, feel free to submit issues, open pull requests, or reach out for suggestions.
## License
`HumanReadableFormatter.jl` is open-source software, available under the MIT License.
---