Skip to content

Commit

Permalink
Freshen up the README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
micktwomey committed Sep 28, 2022
1 parent 3b883c3 commit bac0dd9
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 13 deletions.
15 changes: 9 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
==========

Expand Down Expand Up @@ -117,6 +119,7 @@ unreleased
----------

* Drop Python 3.6 support (3.6 is end of life)
* Freshen up README

1.1.0
-----
Expand Down
22 changes: 15 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
============

Expand All @@ -74,10 +89,3 @@ API

.. autoexception:: iso8601.ParseError

Authors
=======

Currently active or previously active committers:

- Michael Twomey
- Julien Danjou

0 comments on commit bac0dd9

Please sign in to comment.