Merge branch 'master' into develop

Author: sdispater

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 
-[Unreleased]
+## [1.1.1] - 2017-03-14
+
+### Fixed
+
+- Fixed `diff_for_humans()` when crossing DST transitions.
+
+
+## [1.1.0] - 2017-02-20
 
 ### Added
 
@@ -13,7 +20,7 @@
 - Formatting (with f-strings or `format()`) will now use the configured formatter.
 
 
-## [1.0.2]
+## [1.0.2] - 2017-02-04
 
 ### Changed
 
@@ -24,14 +31,14 @@
 - Fixed `day_of_year` not returning the correct value. (Thanks to [asrenzo](https://github.com/asrenzo))
 
 
-## [1.0.1]
+## [1.0.1] - 2017-01-25
 
 ### Fixed
 
 - Fixed parsing, especially for strings in the form `31-01-01`.
 
 
-## [1.0.0]
+## [1.0.0] - 2017-01-17
 
 ### Changed
 
@@ -333,7 +340,9 @@ Initial release
 
 
 
-[Unreleased]: https://github.com/sdispater/pendulum/compare/1.0.2...develop
+[Unreleased]: https://github.com/sdispater/pendulum/compare/1.1.1...master
+[1.1.1]: https://github.com/sdispater/pendulum/releases/tag/1.1.1
+[1.1.0]: https://github.com/sdispater/pendulum/releases/tag/1.1.0
 [1.0.2]: https://github.com/sdispater/pendulum/releases/tag/1.0.2
 [1.0.1]: https://github.com/sdispater/pendulum/releases/tag/1.0.1
 [1.0.0]: https://github.com/sdispater/pendulum/releases/tag/1.0.0

docs/_docs/instantiation.rst

@@ -140,8 +140,14 @@ You can also instantiate ``Pendulum`` instances by passing a string to the ``par
     print(dt)
     '1975-05-21T22:00:00+00:00
 
-The library natively supports the RFC 3339 format, most ISO 8601 formats and some other common formats. If you pass a non-standard or more complicated
-string, the library will fallback on the `dateutil <https://dateutil.readthedocs.io>`_ parser.
+    # You can pass a tz keyword to specify the timezone
+    dt = pendulum.parse('1975-05-21 22:00:00', tz='Europe/Paris')
+    print(dt)
+    '1975-05-21T22:00:00+01:00'
+
+The library natively supports the RFC 3339 format, most ISO 8601 formats and some other common formats.
+If you pass a non-standard or more complicated string, the library will fallback on the
+`dateutil <https://dateutil.readthedocs.io>`_ parser.
 
 RFC 3339
 ~~~~~~~~

docs/_docs/period.rst

@@ -37,13 +37,42 @@ instances that generated it, so that it can give access to more methods and prop
 
     # Note that the weeks property
     # will change compared to the Interval class
-    period.weeks = 2 # 832 for the interval
+    period.weeks
+    2 # 832 for the interval
 
     # However the days property will still remain the same
     # to keep the compatiblity with the timedelta class
     period.days
     5829
 
+Be aware that a period, just like an interval, is compatible with the ``timedelta`` class regarding
+its attributes. However, its custom attributes (like ``remaining_days``) will be aware of any DST
+transitions that might have occurred and adjust accordingly. Let's take an example:
+
+.. code-block:: python
+
+    import pendulum
+
+    start = pendulum.create(2017, 3, 7, tz='America/Toronto')
+    end = start.add(days=6)
+
+    period = end - start
+
+    # timedelta properties
+    period.days
+    5
+    period.seconds
+    82800
+
+    # period properties
+    period.remaining_days
+    6
+    period.hours
+    0
+    period.remaining_seconds
+    0
+
+
 .. warning::
 
     Due to its nature (fixed duration between two datetimes), most arithmetic operations will

docs/conf.py

@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '1.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.2'
+release = '1.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/_docs/date.rst docs/date/index.rstdocs/_docs/date.rst renamed to docs/date/index.rst

@@ -1,3 +1,11 @@
+.. toctree::
+    :hidden:
+    :maxdepth: 2
+
+    index
+    date/index
+    time/index
+
 .. include:: _docs/installation.rst
 .. include:: _docs/introduction.rst
 .. include:: _docs/instantiation.rst
@@ -14,5 +22,3 @@
 .. include:: _docs/interval.rst
 .. include:: _docs/period.rst
 .. include:: _docs/limitations.rst
-.. include:: _docs/date.rst
-.. include:: _docs/time.rst

docs/index.rst

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 
+from .parsing.exceptions import ParserError
+
 
 class PendulumException(BaseException):
 

docs/_docs/time.rst docs/time/index.rstdocs/_docs/time.rst renamed to docs/time/index.rst

@@ -63,9 +63,9 @@ def diff_for_humans(self, date, other=None, absolute=False, locale=None):
 
             if diff.remaining_days > 3:
                 count += 1
-        elif diff.days > 0:
+        elif diff.remaining_days > 0:
             unit = 'day'
-            count = diff.days
+            count = diff.remaining_days
         elif diff.hours > 0:
             unit = 'hour'
             count = diff.hours

pendulum/exceptions.py

@@ -99,6 +99,14 @@ def days(self):
     def remaining_days(self):
         return abs(self._delta['days']) % 7 * self._sign(self._days)
 
+    @property
+    def hours(self):
+        return self._delta['hours']
+
+    @property
+    def minutes(self):
+        return self._delta['minutes']
+
     @property
     def start(self):
         return self._start