Updating version to 1.0.0.0

Adding release notes.
removing comments about branch pyxnat requests.

Author: DavidJJ

CHANGES.rst

@@ -1,12 +1,28 @@
 Latest changes
 ===============
 
+Release 1.0.0.0
+
+    * New Features
+        - Convenience methods on interface: get, put, post, delete, head
+        - Verify option on interface for ssl-cert-verification
+
+    * Improvements
+        - More useful error messages when things go wrong
+        - streaming file upload
+        - streaming file download
+        - Use the requests library instead of httplib2 for REST calls
+
+    * Bug fixes:
+        - Removed custom httplib2 caching. 
+
 Release 0.9.5.2
-   * New Features
 
-   * Improvements
+    * New Features
 
-   * Bug fixes:
+    * Improvements
+
+    * Bug fixes:
         - Ticket #50 404 error causes connection to be broken until end of object life.
         - Tiekct #52 fix zip file downloading.
 
@@ -30,7 +46,7 @@ Release 0.9.4
 
     * New Features
         - add proxy support to interface.
-        
+
     * Impovements
 
     * Bug fixes:
@@ -49,7 +65,7 @@ Release 0.9.0
             - interface.array.experiments()
 	    - interface.array.search_experiments()
 	    - interface.array.scans()
-	       
+
         - Support for XNAT configuration file format
         - Batch function for downloading all files related to a scan or an assessor
         - Create element with an XML document
@@ -60,7 +76,7 @@ Release 0.9.0
         - Catching authentication errors
         - Toggle option for cache warnings
         - Description for search templates is displayed
-      
+
     * Bug fixes:
         - Config file
 
@@ -117,7 +133,7 @@ Release 0.7.0
 
     * Bug fix for HTTP sessions management.
 
-    * New `last_modified` method for project to get subjects last modified 
+    * New `last_modified` method for project to get subjects last modified
       date.
 
     * Resource elements are now fully configurable at creation.
@@ -127,7 +143,7 @@ Release 0.7.0
     * Added push and pull zip files at the resource level.
 
     * Added simple schema parsing capabilities.
-    
+
     * Add a global management interface to gather different managers.
 
     * Interface now follows redirections on the server url.

pyxnat/core/interfaces.py

@@ -67,9 +67,9 @@ class Interface(object):
             installed via pip:
             pip install SocksiPy-branch
 
-        .. note:: 
-            Pyxnat-requests branch completely removes all of the caching 
-            functionality from pyxnat. The cache was causing more hassle than it was worth.
+        .. note::
+            All caching functionality has been removed from pyxnat as of 1.0.0.0.
+            The cache was causing more hassle than it was worth.
 
     """
 
@@ -92,15 +92,8 @@ def __init__(self, server=None, user=None, password=None,
             password: string | None
                 The user's password.
                 If None the user will be prompted for it.
-            cachedir: string
-                .. note:: 
-                Pyxnat-requests branch completely removes all of the caching 
-                functionality from pyxnat.
-
-                Path of the cache directory (for all queries and
-                downloaded files)
-                If no path is provided, a platform dependent temp dir is
-                used.
+            cachedir: string  (Depricated)
+
             config: string
                 Reads a config file in json to get the connection parameters.
                 If a config file is specified, it will be used regardless of
@@ -115,7 +108,7 @@ def __init__(self, server=None, user=None, password=None,
                 specify a username and password for proxy access, prepend them
                 to the hostname:
                 http://user:pass@hostname:port
-                
+
             verify: True, False, or path to file containing certificate for your site
               Added to the requests Session, as documented here:
               http://docs.python-requests.org/en/latest/user/advanced/#ssl-cert-verification
@@ -127,8 +120,8 @@ def __init__(self, server=None, user=None, password=None,
         self._interactive = False
 
         self._anonymous = anonymous
-        
-        self._verify = verify 
+
+        self._verify = verify
 
         if self._anonymous:
 
@@ -162,7 +155,7 @@ def __init__(self, server=None, user=None, password=None,
                 self._server = connection_args['host']
                 self._user = connection_args['u']
                 self._pwd = connection_args['p']
-                
+
 
                 if 'proxy' in connection_args:
                     self.__set_proxy(connection_args['proxy'])
@@ -313,19 +306,19 @@ def _exec(self, uri, method='GET', body=None, headers=None, force_preemptive_aut
             headers: dict
                 Additional headers for the HTTP request.
             force_preemptive_auth: boolean
-                .. note:: Depricated with Pyxnat-requests
+                .. note:: Depricated as of 1.0.0.0
                 Indicates whether the request should include an Authorization header with basic auth credentials.
             **kwargs: dictionary
                 Additional parameters to pass directly to the Requests HTTP call.
 
             HTTP:GET
             ----------
-                When calling with GET as method, the body parameter can be a key:value dictionary containing 
+                When calling with GET as method, the body parameter can be a key:value dictionary containing
                 request parameters or a string of parameters. They will be url encoded and appended to the url.
 
             HTTP:POST
             ----------
-                When calling with POST as method, the body parameter can be a key:value dictionary containing 
+                When calling with POST as method, the body parameter can be a key:value dictionary containing
                 request parameters they will be url encoded and appended to the url.
 
         """
@@ -477,7 +470,7 @@ def load_config(self, location):
             self._server = str(config['server'])
             self._user = str(config['user'])
             self._pwd = str(config['password'])
-            
+
             if 'proxy' in config:
                 self.__set_proxy(str(config['proxy']))
             else:
@@ -543,6 +536,3 @@ def head(self, uri, **kwargs):
         uri = join_uri(self._server, uri)
         response = self._http.head(uri, **kwargs)
         return response
-
-
-

pyxnat/core/resources.py

@@ -572,15 +572,15 @@ def _call(self, columns):
 
             request_shape = uri_shape(
                 '%s/0' % uri.split(self._intf._get_entry_point(), 1)[1])
-            
+
             gather = uri.split('/')[-1] in ['experiments', 'assessors',
                                             'scans', 'reconstructions']
 
             tick = time.gmtime(time.time())[5] % \
                 self._intf.inspect._tick == 0 and\
                 self._intf.inspect._auto
 
-            
+
             columns += ['xsiType']
 
             query_string = '?format=json&columns=%s' % ','.join(columns)
@@ -598,7 +598,7 @@ def _call(self, columns):
                 print uri + query_string
             jtable = self._intf._get_json(uri + query_string)
 
-            
+
             _type = uri.split('/')[-1]
             self._learn_from_table(_type, jtable, None)
 
@@ -623,7 +623,7 @@ def _learn_from_table(self, _type, jtable, reqcache):
                 request_knowledge[shape] = xsitype
 
         self._intf._struct.update(request_knowledge)
-        
+
 
     def __iter__(self):
         if self._ctype == 'cobjectcuri':
@@ -1807,7 +1807,7 @@ def get(self, dest=None, force_default=False):
                     Path should include the file name.
                     eg: /path/to/file.txt
             force_default: boolean
-                - Depricated with pyxnat-requests
+                - Depricated as of 1.0.0.0
                 - Has no effect if the file is downloaded for the first time
                 - If the file was previously download with a custom path,
                   calling get() will remember the custom location unless:
@@ -1930,7 +1930,7 @@ def put(self, src, format='U', content='U', tags='U', overwrite=False, **datatyp
             'overwrite': 'true' if overwrite else 'false',
             'inbody':'true'
             }
-        
+
         if '?' in self._absuri:
             k, v = self._absuri.split('?')[1].split('=')
             query_args[k] = v

pyxnat/version.py

@@ -1,2 +1 @@
-VERSION='0.9.5.4'
-
+VERSION='1.0.0.0'

requirements.txt

@@ -1,2 +1,2 @@
-httplib2==0.7.3
 lxml==2.3.2
+requests=2.1.0