https://github.com/hustcc/timeago

:hourglass: Simple library used to format datetime with `*** time ago` statement. eg: "3 hours ago".
https://github.com/hustcc/timeago

datetime format-datetime multi-language python timeago

Last synced: about 2 hours ago
JSON representation

:hourglass: Simple library used to format datetime with `*** time ago` statement. eg: "3 hours ago".

• Host: GitHub
• URL: https://github.com/hustcc/timeago
• Owner: hustcc
• License: mit
• Created: 2016-05-26T05:00:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-09-14T04:42:03.000Z (about 2 years ago)
• Last Synced: 2024-10-30T18:04:30.262Z (14 days ago)
• Topics: datetime, format-datetime, multi-language, python, timeago
• Language: Python
• Homepage: http://timeago.org
• Size: 117 KB
• Stars: 223
• Watchers: 8
• Forks: 37
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# timeago

A very simple python lib, used to format datetime with `*** time ago` statement. Javascript version here. [timeago.js](https://github.com/hustcc/timeago.js).

[![Build Status](https://travis-ci.org/hustcc/timeago.svg?branch=master)](https://travis-ci.org/hustcc/timeago) [![PyPi Status](https://img.shields.io/pypi/v/timeago.svg)](https://pypi.python.org/pypi/timeago) [![Python Versions](https://img.shields.io/pypi/pyversions/timeago.svg)](https://pypi.python.org/pypi/timeago) 

Such as: 

```

just now

12 seconds ago

3 minutes ago

2 hours ago

24 days ago

6 months ago

2 years ago

in 12 seconds

in 3 minutes

in 2 hours

in 24 days

in 6 months

in 2 years

```

For other languages see below. 

## Install

```sh

pip install timeago

```

## Usage & Example

```py

# -*- coding: utf-8 -*-

import timeago, datetime

now = datetime.datetime.now() + datetime.timedelta(seconds = 60 * 3.4)

date = datetime.datetime.now()

# locale

print (timeago.format(date, now, 'zh_CN')) # will print `3分钟前`

# input datetime

print (timeago.format(date, now)) # will print 3 minutes ago

# input timedelta

print (timeago.format(datetime.timedelta(seconds = 60 * 3.4))) # will print 3 minutes ago

# input date, auto add time(0, 0, 0)

print (timeago.format(datetime.date(2016, 5, 27), now))

# input datetime formatted string

print (timeago.format('2016-05-27 12:12:03', '2016-05-27 12:12:12')) # will print just now

# inverse two parameters

print (timeago.format('2016-05-27 12:12:12', '2016-05-27 12:12:03')) # will print a while

```

## Method & Parameter

only one API **`format`**.

Three parameters of method `format`:

 - **`date`**: the parameter which will be formatted, must be instance of `datetime` / `timedelta` or datetime formatted string.

 - **`now`**: reference time, must be instance of `datetime` or datetime formatted string.

 - **`locale`**: the locale code, default `en`. 

## Locale

At the time we're speaking, [following locale](src/timeago/locales) are available:

 - `ar`

 - `bg`

 - `ca`

 - `da`

 - `de`

 - `el`

 - `en`

 - `en_short`

 - `es`

 - `eu`

 - `fa_IR`

 - `fi`

 - `fr`

 - `gl`

 - `guj_IN`

 - `he`

 - `hu`

 - `in_BG`

 - `in_HI`

 - `in_ID`

 - `is`

 - `it`

 - `ja`

 - `ko`

 - `lt`

 - `ml`

 - `my`

 - `nb_NO`

 - `nl`

 - `nn_NO`

 - `pl`

 - `pt_BR`

 - `pt_PT`

 - `ro`

 - `ru`

 - `sk`

 - `sv_SE`

 - `ta`

 - `th`

 - `tr`

 - `uk`

 - `vi`

 - `zh_CN`

 - `zh_TW`

## Localization

1. Fork the project

2. Create a locale python script called `[name_of_your_locale].py` following the existing other locales.

3. Add the name of your locale in the Readme (both in MD and in RST) to keep it updated (**alphabetically**).

4. Add test case following the [english model](/test/testcase.py#L50)

5. Create the Pull Request.

### Notes

For complicated plurals, you can take example on the PL :flag-pl: locale [here](src/timeago/locales/pl.py)