README: document __init__-level import
This commit is contained in:
parent
c05d6157a1
commit
f591389eb1
11
README.rst
11
README.rst
@ -11,7 +11,8 @@ A small Python library to parse various kinds of time expressions,
|
||||
inspired by
|
||||
`this StackOverflow question <http://stackoverflow.com/questions/4628122/how-to-construct-a-timedelta-object-from-a-simple-string>`_.
|
||||
|
||||
The single function ``timeparse`` defined in the module parses time
|
||||
The single function ``pytimeparse.timeparse.timeparse`` defined in the
|
||||
library (also available as ``pytimeparse.parse``) parses time
|
||||
expressions like the following:
|
||||
|
||||
- ``32m``
|
||||
@ -51,17 +52,17 @@ expressions like the following:
|
||||
It returns the time as a number of seconds (an integer value if
|
||||
possible, otherwise a floating-point number)::
|
||||
|
||||
>>> from pytimeparse.timeparse import timeparse
|
||||
>>> timeparse('1.2 minutes')
|
||||
>>> from pytimeparse import parse
|
||||
>>> parse('1.2 minutes')
|
||||
72
|
||||
|
||||
A number of seconds can be converted back into a string using the
|
||||
``datetime`` module in the standard library, as noted in
|
||||
`this other StackOverflow question <http://stackoverflow.com/questions/538666/python-format-timedelta-to-string>`_::
|
||||
|
||||
>>> from pytimeparse.timeparse import timeparse
|
||||
>>> from pytimeparse import parse
|
||||
>>> import datetime
|
||||
>>> timeparse('1 day, 14:20:16')
|
||||
>>> parse('1 day, 14:20:16')
|
||||
138016
|
||||
>>> str(datetime.timedelta(seconds=138016))
|
||||
'1 day, 14:20:16'
|
||||
|
Loading…
Reference in New Issue
Block a user