From bac0dd9363a3c95eba5b033aa93c2c274915c1a7 Mon Sep 17 00:00:00 2001 From: Michael Twomey Date: Wed, 28 Sep 2022 16:08:06 +0100 Subject: [PATCH] Freshen up the README and docs --- README.rst | 15 +++++++++------ docs/index.rst | 22 +++++++++++++++------- 2 files changed, 24 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index d9498db..cd734c9 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,13 @@ Simple module to parse ISO 8601 dates +`pip install iso8601` + +Documentation: https://pyiso8601.readthedocs.org/ + +PyPI: https://pypi.org/project/iso8601/ + +Source: https://github.com/micktwomey/pyiso8601 + This module parses the most common forms of ISO 8601 date strings (e.g. 2007-01-14T20:34:22+00:00) into datetime objects. >>> import iso8601 @@ -56,12 +64,6 @@ Known differences from the ISO 8601 spec: - Days and months without a leading 0 (2 vs 02) will be parsed. - If time zone information is omitted the default time zone given is used (which in turn defaults to UTC). Use a default of None to yield naive datetime instances. -Homepage -======== - -- Documentation: https://pyiso8601.readthedocs.org/ -- Source: https://github.com/micktwomey/pyiso8601 - References ========== @@ -117,6 +119,7 @@ unreleased ---------- * Drop Python 3.6 support (3.6 is end of life) +* Freshen up README 1.1.0 ----- diff --git a/docs/index.rst b/docs/index.rst index ac1cfb7..369b071 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,12 @@ pyiso8601: ISO 8601 Parsing for Python ====================================== +Documentation: https://pyiso8601.readthedocs.org/ + +PyPI: https://pypi.org/project/iso8601/ + +Source: https://github.com/micktwomey/pyiso8601 + This module parses the most common forms of ISO 8601 date strings (e.g. 2007-01-14T20:34:22+00:00) into datetime objects. >>> import iso8601 @@ -57,6 +63,15 @@ Known differences from the ISO 8601 spec: - Days and months without a leading 0 (2 vs 02) will be parsed. - If time zone information is omitted the default time zone given is used (which in turn defaults to UTC). Use a default of None to yield naive datetime instances. +References +========== + +- https://en.wikipedia.org/wiki/ISO_8601 + +- https://www.cl.cam.ac.uk/~mgk25/iso-time.html - simple overview + +- https://web.archive.org/web/20090309040208/http://hydracen.com/dx/iso8601.htm - more detailed enumeration of valid formats. + Installation ============ @@ -74,10 +89,3 @@ API .. autoexception:: iso8601.ParseError -Authors -======= - -Currently active or previously active committers: - -- Michael Twomey -- Julien Danjou