Skip to main content

Better dates & times for Python

Project description

Build Status Codecov PyPI Version Supported Python Versions License Code Style: Black

Arrow is a Python library that offers a sensible and 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 providing 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 named after the arrow of time and is heavily inspired by moment.js and requests.

Why use Arrow over built-in modules?

Python’s standard library and some other low-level modules have near-complete date, time and timezone 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.
  • Timezones and timestamp conversions are verbose and unpleasant
  • Timezone naivety is the norm
  • Gaps in functionality: ISO-8601 parsing, timespans, humanization

Features

  • Fully-implemented, drop-in replacement for datetime
  • Supports Python 2.7, 3.5, 3.6, 3.7 and 3.8
  • Timezone-aware and UTC by default
  • Provides super-simple creation options for many common input scenarios
  • shift method with support for relative offsets, including weeks
  • Formats and parses strings automatically
  • Wide support for ISO-8601
  • Timezone conversion
  • Timestamp available as a property
  • Generates time spans, ranges, floors and ceilings for time frames ranging from microsecond to year
  • Humanizes and supports a growing list of contributed locales
  • Extensible for your own Arrow-derived types

Quick Start

Installation

To install Arrow, use pip or pipenv:

$ pip install -U arrow

Example Usage

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

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

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

>>> local = utc.to('US/Pacific')
>>> local
<Arrow [2013-05-11T13:23:58.970460-07: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시간 전'

Documentation

For full documentation, please visit arrow.readthedocs.io.

Contributing

Contributions are welcome for both code and localizations (adding and updating locales). Begin by gaining familiarity with the Arrow library and its features. Then, jump into contributing:

  1. Find an issue or feature to tackle on the issue tracker. Issues marked with the “good first issue” label may be a great place to start!
  2. Fork this repository on GitHub and begin making changes in a branch.
  3. Add a few tests to ensure that the bug was fixed or the feature works as expected.
  4. Submit a pull request and await feedback 😃.

If you have any questions along the way, feel free to ask them here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for arrow, version 0.15.2
Filename, size File type Python version Upload date Hashes
Filename, size arrow-0.15.2-py2.py3-none-any.whl (40.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size arrow-0.15.2.tar.gz (71.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page