Metadata-Version: 2.1
Name: simple_notifs
Version: 0.0.1
Summary: A python library for creating simple, shortened notification time deltas. This is specifically helpful when time differences like `1h` or `2w` are needed to show a how long something has existed as of right now.
Project-URL: Homepage, https://github.com/nicosanc/simple_notifs
Project-URL: Bug Tracker, https://github.com/nicosanc/simple_notif/issues
Author-email: Nico Sanchez <nicosanchez0411@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: arrow
Description-Content-Type: text/markdown

# Introduction

This library was built for making simple, shortened human readable versions of time deltas. 
This was specifically made for notificationon applications where a user wants to see how long it has been
since the notification was made. Instead of "1 hour ago" or "20 minutes ago", the resulting time delta would be
"1h" and "20mi", respectively

## Access
From simple_notifs.simple_notifs import utc_to_human

## Arguments

Mandatory, a datetime object must be passed as input to the function. 
By default, is_utc is set to True. If false, the built in method converts the datetime object to utc, then performs its operation.
By default, days_and_above is set to False. If True, the built in method will only display time deltas starting at "1d". This means any deltas
in seconds, minutes, or hours that are less than a full day, will be truncated to "1d".