Metadata-Version: 1.1
Name: collective.prettydate
Version: 1.2
Summary: Represents a date on a relative format so, instead of '01/02/2012', it would be displayed as '4 hours ago', 'yesterday' or 'last week', which is easier to read and understand for most people.
Home-page: https://github.com/collective/collective.prettydate
Author: Franco Pellegrini
Author-email: frapell@gmail.com
License: GPLv2
Description: *********************
        collective.prettydate
        *********************
        
        .. contents:: Table of Contents
        
        Life, the Universe, and Everything
        ----------------------------------
        
        collective.prettydate is a package that helps developers to solve some
        usability issues associated with the utilization of absolute date formating on
        sites used among different timezones.
        
        When a date is printed as "01/02/2012" it could represent "February 1" or
        "January 2", depending on the format used. Also, if the site is located on a
        different timezone, it could take you to situations when today's date is
        printed as yesterday, or tomorrow's date.
        
        collective.prettydate represents a date on a relative format so it would be
        displayed as "4 hours ago", "yesterday" or "last week", which is easier to
        read and understand for most people.
        
        This feature is really nice for news sites or sites with upcoming events.
        
        Don't Panic
        -----------
        
        This product provides a utility which will convert a DateTime object into a
        human readable text.
        
        ::
        
            from zope.component import getUtility
            from collective.prettydate.interfaces import IPrettyDate
            date_utility = getUtility(IPrettyDate)
        
        At this point, you can use the 'date' method to convert the DateTime object::
        
            from DateTime import DateTime
            today = DateTime()
            str_date = date_utility.date(today)
        
        In previous example, 'str_date' will be "now"
        
        The 'date' method also allows 2 additional parameters: 'short' and 'asdays'
        which will modify the output to be in short format ('h' instead of 'hours',
        'd' instead of 'days', etc) and whole days (it will use 'today' instead of any
        amount of seconds, minutes or hours for current day). They both default to
        "False".
        
        Timezones
        ^^^^^^^^^
        
        If your server timezone is configured correctly, and the DateTime object
        contains valid timezone info, then the text output will reflect the correct
        time. You do not need to convert date and time between different timezones.
        
        Output examples
        ^^^^^^^^^^^^^^^
        
        * '4 hours ago'
        * '4h ago' (short format)
        * 'in 28 minutes'
        * 'in 6 months'
        * 'today'
        * 'last week'
        * 'yesterday'
        * 'last year'
        
        DateTime 3.0
        ^^^^^^^^^^^^
        
        collective.prettydate is fully compatible with `DateTime 3.0`_ which provides
        a significantly smaller memory footprint.
        
        Mostly Harmless
        ---------------
        
        .. image:: https://secure.travis-ci.org/collective/collective.prettydate.png
            :target: http://travis-ci.org/collective/collective.prettydate
        
        Have an idea? Found a bug? Let us know by `opening a support ticket`_.
        
        .. _`DateTime 3.0`: http://pypi.python.org/pypi/DateTime
        .. _`opening a support ticket`: https://github.com/collective/collective.prettydate/issues
        
        
        Installation
        ------------
        
        To enable this product in a buildout-based installation:
        
        1. Edit your buildout.cfg and add ``collective.prettydate`` to the list of
           eggs to install ::
        
            [buildout]
            ...
            eggs =
                collective.prettydate
        
        After updating the configuration you need to run ''bin/buildout'', which will
        take care of updating your system.
        
        
        Share and Enjoy
        ---------------
        
        ``collective.prettydate`` would not have been possible without the
        contribution of the following people:
        
        - Franco Pellegrini
        - Héctor Velarde
        - Juan A. Díaz
        
        You can find an updated list of package contributors on `GitHub`_.
        
        This package is based on `py-pretty`_.
        
        Development sponsored by Open Multimedia.
        
        .. _`py-pretty`:  http://pypi.python.org/pypi/py-pretty
        .. _`GitHub`: https://github.com/collective/collective.prettydate/contributors
        
        Changelog
        ---------
        
        Because you have to know where your towel is.
        
        1.2 (2013-03-19)
        ^^^^^^^^^^^^^^^^
        
        - Added Finnish translation. [petri]
        
        - Added Italian translation. [gborelli]
        
        - Tested compatibility with Plone 4.3. [hvelarde]
        
        - Updated documentation. [hvelarde]
        
        - Tested compatibility with Plone 4.0. [hvelarde]
        
        
        1.1 (2012-05-29)
        ^^^^^^^^^^^^^^^^
        
        - Removed unused test module. [hvelarde]
        
        - Remove unnecessary generic setup profile. [nueces]
        
        - Package no longer depends on five.grok (fixes #3). [frapell]
        
        
        1.0 (2012-05-04)
        ^^^^^^^^^^^^^^^^
        
        - Tested compatibility with Plone 4.2. [hvelarde]
        
        - Tested compatibility with DateTime 3.0 which provides a significantly
          smaller memory footprint. [hvelarde]
        
        
        1.0rc1 (2012-02-21)
        ^^^^^^^^^^^^^^^^^^^
        
        - Initial release.
        
Keywords: plone prettydate datetime
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.1
Classifier: Framework :: Plone :: 4.2
Classifier: Framework :: Plone :: 4.3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Office/Business :: News/Diary
Classifier: Topic :: Software Development :: Libraries :: Python Modules
