Metadata-Version: 2.4
Name: tformat
Version: 0.1.0
Summary: Efficient conversion of timestamps to human-readable equivalents
Home-page: https://github.com/cartertemm/tformat
Author: Carter Temm
Author-email: Carter Temm <cartertemm@gmail.com>
License-Expression: MIT OR CC0-1.0
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Utilities
Requires-Python: >=2
Description-Content-Type: text/markdown
License-File: license.md
Dynamic: author
Dynamic: home-page
Dynamic: license-file

## The Problem

You have a timestamp from somewhere (a database, elapsed timer, whatever) that you need to cleanly display.

Google presents a variety of solutions which are either half baked, partially broken, unnecessarily complex or just plain ugly.

I got tired of implementing this in different ways across different projects, so here we are.

```
>>> from tformat import format_time
>>> format_time(290390, ms=False)
'3 days, 8 hours, 39 minutes and 50 seconds'

>>> format_time(36400000, ms=True)
'10 hours, 6 minutes and 40 seconds'

>>> format_time(time.time())
'2662 weeks, 2 days, 20 hours, 8 minutes and 14 seconds'
```

## Installation

From pip:
```
pip install tformat
```
Or from source:
```
git clone https://github.com/cartertemm/tformat.git
cd tformat
pip install .
```

Or just copy the file (or it's contents) to where ever it fits in your project.

## Licensing

As part of an effort to publicize more of the code/libraries I use every day, this software is both released under the MIT and into the public domain. Choose which ever you prefer.

### MIT

Copyright (c) 2025 Carter Temm

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

### Public Domain

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
