1.2.4 release

hydroshare · Sep 2, 2016 · 13846de · 13846de
1 parent aca9f37
commit 13846de
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,3 +1,7 @@
+# 1.2.4 - 9/2/2016
+  - Add support for async resource bag (BagIt archive) creation prior to downloading
+  the bag file in getResource()
+
 # 1.2.3 - 7/12/2016
   - Add ability to supply metadata (in addition to 'title', 'abstract', and 'keywords')
   to createResource()

diff --git a/docs/index.rst b/docs/index.rst
@@ -153,6 +153,18 @@ or to get the BagIt archive as a generator (sort of like a buffered stream):
     >>>     for chunk in resource:
     >>>         fd.write(chunk)
 
+Note that when the BagIt archive is not ready for download (this archive zip file needs to be
+recreated) the client by default will wait until the BagIt archive is recreated. This may take a
+while. If you want to get the BagIt archive only if it is ready for download:
+
+    >>> from hs_restclient import HydroShare
+    >>> hs = HydroShare()
+    >>>try:
+    >>>     hs.getResource('e62a438bec384087b6c00ddcd1b6475a', destination='/tmp', wait_for_bag_creation=False)
+    >>>except HydroShareBagNotReadyException as e:
+    >>>     print('BagIt file is being generated and not ready for download at this time.')
+
+
 To create a resource:
 
     >>> from hs_restclient import HydroShare, HydroShareAuthBasic

diff --git a/hs_restclient/__init__.py b/hs_restclient/__init__.py
@@ -5,7 +5,7 @@
 """
 
 __title__ = 'hs_restclient'
-__version__ = '1.2.3'
+__version__ = '1.2.4'
 
 
 import os

diff --git a/setup.py b/setup.py
@@ -15,7 +15,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='1.2.3',
+    version='1.2.4',
 
     description='HydroShare REST API client library',
     long_description=long_description,