Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/KoffeinFlummi/Chronyk

A Python 3 library for parsing human-written times and dates
https://github.com/KoffeinFlummi/Chronyk

Last synced: about 2 months ago
JSON representation

A Python 3 library for parsing human-written times and dates

Lists

README 

        
Chronyk

======



[![Build Status](http://img.shields.io/travis/KoffeinFlummi/Chronyk/master.svg?style=flat)](https://travis-ci.org/KoffeinFlummi/Chronyk) [![Code Coverage](http://img.shields.io/coveralls/KoffeinFlummi/Chronyk.svg?style=flat)](https://coveralls.io/r/KoffeinFlummi/Chronyk) [![PyPi](http://img.shields.io/pypi/v/Chronyk.svg?style=flat)](https://pypi.python.org/pypi/Chronyk) [![License](http://img.shields.io/pypi/l/Chronyk.svg?style=flat)](https://github.com/KoffeinFlummi/Chronyk/blob/master/LICENSE)



A small Python 3 library containing some handy tools for handling time, especially when it comes to interfacing with those pesky humans.



## Features

- Parsing human-written strings ("10 minutes ago", "10. April 2015", "2014-02-15"...)

- Relative time string creation ("in 2 hours", "5 hours ago")

- Various input formats

- Easy to use



## Installation



```bash

$ pip install chronyk

```



## Usage



**Basic:**



```python

>>> from chronyk import Chronyk

>>> t = Chronyk(1410531179.0)

>>> t = Chronyk("May 2nd, 2016 12:51 am")

>>> t = Chronyk("yesterday")

>>> t = Chronyk("21. 8. 1976 23:18")

>>> t = Chronyk("2 days and 30 hours ago")

>>> t.ctime()

'Tue Sep  9 05:59:39 2014'

>>> t.timestamp()

1410235179.0

>>> t.timestring()

'2014-09-09 05:59:39'

>>> t.timestring("%Y-%m-%d")

'2014-09-09'

>>> t.relativestring()

'3 days ago'

>>> t.date()

datetime.date(2014, 9, 9)

>>> t.datetime()

datetime.datetime(2014, 9, 9, 5, 59, 39)

```



**Input validation:**



```python

import sys

import chronyk



timestr = input("Please enter the date you were born: ")

try:

    date = chronyk.Chronyk(timestr, allowfuture=False)

except chronyk.DateRangeError:

    print("Yeah, right.")

    sys.exit(1)

except ValueError:

    print("Failed to parse birthdate.")

    sys.exit(1)

else:

    print("You were born {}".format(date.relativestring()))

```



**Timezones:**



By default, the Chronyk constructor uses local time, and every method by default uses whatever was passed to the constructor as well.



Almost all methods, however, have a timezone keyargument that you can use to define your local offset from UTC in seconds (positive for west, negative for east).



If you want to use a certain timezone for more than one method, you can also change the `timezone` instance attribute itself:

```python

>>> t = Chronyk("4 hours ago", timezone=0) # using UTC

>>> t.ctime()

'Tue Sep  9 10:53:42 2014'

>>> t.timezone = -3600 # changes to CET (UTC+1)

>>> t.relativeTime()

'5 hours ago'

>>> t.ctime()

'Tue Sep  9 09:53:42 2014'

```



This uses the local relative time and returns a time string relative to current UTC:

```python

>>> t = Chronyk("4 hours ago")

>>> t.relativestring(timezone=0)

'3 hours ago'

```



This uses a UTC timestamp and returns a time string relative to local time:

```python

>>> t = Chronyk(1410524713.69, timezone=0)

>>> t.relativestring(timezone=chronyk.LOCALTZ)

'2 hours ago'

```