lib/python/vendor/arrow-0.10.0/README.rst
author Ben Hearsum <bhearsum@mozilla.com>
Fri, 31 Mar 2017 10:01:20 -0400
changeset 7413 0a0b27078a1856d43a068f4fabd12a536c533f78
permissions -rw-r--r--
bug 1347212: improve release automation publishing of releases - add support for scheduling publishing of releases. r=rail

Arrow - Better dates & times for Python
=======================================

.. image:: https://travis-ci.org/crsmithdev/arrow.svg
   :alt: build status
   :target: https://travis-ci.org/crsmithdev/arrow

.. image:: https://codecov.io/github/crsmithdev/arrow/coverage.svg?branch=master
   :target: https://codecov.io/github/crsmithdev/arrow
   :alt: Codecov

.. image:: https://img.shields.io/pypi/v/arrow.svg
   :target: https://pypi.python.org/pypi/arrow
   :alt: downloads
        
Documentation: `arrow.readthedocs.org <http://arrow.readthedocs.org/en/latest/>`_
---------------------------------------------------------------------------------

What?
-----

Arrow is a Python library that offers a sensible, human-friendly approach to creating, manipulating, formatting and converting dates, times, and timestamps.  It implements and updates the datetime type, plugging gaps in functionality, and provides an intelligent module API that supports many common creation scenarios.  Simply put, it helps you work with dates and times with fewer imports and a lot less code.

Arrow is heavily inspired by `moment.js <https://github.com/timrwood/moment>`_ and `requests <https://github.com/kennethreitz/requests>`_

Why?
----

Python's standard library and some other low-level modules have near-complete date, time and time zone functionality but don't work very well from a usability perspective:

- Too many modules:  datetime, time, calendar, dateutil, pytz and more
- Too many types:  date, time, datetime, tzinfo, timedelta, relativedelta, etc.
- Time zones and timestamp conversions are verbose and unpleasant 
- Time zone naievety is the norm
- Gaps in functionality:  ISO-8601 parsing, timespans, humanization

Features 
--------

- Fully implemented, drop-in replacement for datetime 
- Supports Python 2.6, 2.7, 3.3, 3.4 and 3.5
- Time zone-aware & UTC by default
- Provides super-simple creation options for many common input scenarios
- Updated .replace method with support for relative offsets, including weeks
- Formats and parses strings automatically
- Partial support for ISO-8601
- Timezone conversion
- Timestamp available as a property
- Generates time spans, ranges, floors and ceilings in timeframes from year to microsecond
- Humanizes and supports a growing list of contributed locales
- Extensible for your own Arrow-derived types

Quick start
-----------

First:

.. code-block:: console

    $ pip install arrow

And then:

.. code-block:: pycon

    >>> import arrow
    >>> utc = arrow.utcnow()
    >>> utc
    <Arrow [2013-05-11T21:23:58.970460+00:00]>

    >>> utc = utc.replace(hours=-1)
>>> utc
<Arrow [2013-05-11T20:23:58.970460+        <Arrow [2013-05-11T20:23:58.970460+00:00]>

    >>> local = utc.to('US/Pacific')
>>> local
<Arrow [2013-05-11T13:23:58.97046        <Arrow [2013-05-11T13:23:58.970460-07:00]>

    >>> arrow.get('2013-05-11T21:23:58.970460+00:00')
    <Arrow [2013-05-11T21:23:58.970460+00:00]>

    >>> local.timestamp
    1368303838

    >>> local.format()
    '2013-05-11 13:23:58 -07:00'

    >>> local.format('YYYY-MM-DD HH:mm:ss ZZ')
    '2013-05-11 13:23:58 -07:00'

    >>> local.humanize()
    'an hour ago'

    >>> local.humanize(locale='ko_kr')
    '1시간 전'
    
Further documentation can be found at `arrow.readthedocs.org <http://arrow.readthedocs.org/en/latest/>`_

Contributing
------------

Contributions are welcome, especially with localization.  See `locales.py <https://github.com/crsmithdev/arrow/blob/master/arrow/locales.py>`_ for what's currently supported.