dataverse-utils 0.25.1__tar.gz → 0.25.3__tar.gz

{dataverse_utils-0.25.1 → dataverse_utils-0.25.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dataverse-utils
-Version: 0.25.1
+Version: 0.25.3
 Summary: Utilities for the Dataverse data respository system
 License: MIT
 License-File: LICENCE.md

{dataverse_utils-0.25.1 → dataverse_utils-0.25.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dataverse-utils"
-version = "0.25.1"
+version = "0.25.3"
 description = "Utilities for the Dataverse data respository system"
 authors = [
     {name = "Paul Lesack",email = "paul.lesack@ubc.ca"}

{dataverse_utils-0.25.1 → dataverse_utils-0.25.3}/src/dataverse_utils/__init__.py

@@ -7,7 +7,7 @@ import pathlib
 import sys
 from dataverse_utils.dataverse_utils import *
 
-VERSION = (0, 25, 1)
+VERSION = (0, 25, 3)
 __version__ = '.'.join([str(x) for x in VERSION])
 
 USERAGENT = (f'dataverse_utils/v{__version__} ({sys.platform.capitalize()}); '

{dataverse_utils-0.25.1 → dataverse_utils-0.25.3}/src/dataverse_utils/dataverse_utils.py

@@ -328,7 +328,7 @@ def uningest_file(dv_url, fid, apikey, study='n/a'):
         LOGGER.error('Uningestion error: %s', uningest.reason)
         print(uningest.reason)
 
-def upload_file(fpath, hdl, **kwargs): #pylint:disable=too-many-locals, too-many-statements
+def upload_file(fpath, hdl, **kwargs): #pylint:disable=too-many-locals, too-many-statements, too-many-branches
     '''
     Uploads file to Dataverse study and sets file metadata and tags.
 
@@ -388,6 +388,12 @@ def upload_file(fpath, hdl, **kwargs): #pylint:disable=too-many-locals, too-many
 
     override : bool, optional
         Ignore NOTAB (ie, NOTAB = [])
+
+    return_json : bool
+        Returns the JSON if you need it
+
+    print : bool
+        Print return JSON and file ID to console. Default = True
     '''
     #Why are SPSS files getting processed anyway?
     #Does SPSS detection happen *after* upload
@@ -431,7 +437,8 @@ def upload_file(fpath, hdl, **kwargs): #pylint:disable=too-many-locals, too-many
                            params=params, headers=headers, data=multi,
                            timeout=kwargs.get('timeout',1000))
     try:
-        print(upload.json())
+        if kwargs.get('print', True):
+            print(upload.json())
     except json.decoder.JSONDecodeError as exc:
         #This can happend when Glassfish crashes
         LOGGER.critical(upload.text)
@@ -446,7 +453,8 @@ def upload_file(fpath, hdl, **kwargs): #pylint:disable=too-many-locals, too-many
     #SPSS files still process despite spoof, so there's
     #a forcible unlock check
     fid = upload.json()['data']['files'][0]['dataFile']['id']
-    print(f'FID: {fid}')
+    if kwargs.get('print'):
+        print(f'FID: {fid}')
     if kwargs.get('nowait') and check_lock(dvurl, hdl, kwargs['apikey']):
         force_notab_unlock(hdl, dvurl, fid, kwargs['apikey'])
     else:
@@ -465,6 +473,9 @@ def upload_file(fpath, hdl, **kwargs): #pylint:disable=too-many-locals, too-many
 
     restrict_file(fid=fid, dv=dvurl, apikey=kwargs.get('apikey'),
                   rest=kwargs.get('rest', False))
+    if kwargs.get('return_json'):
+        return upload.json()
+    return None
 
 def restrict_file(**kwargs):
     '''

{dataverse_utils-0.25.1 → dataverse_utils-0.25.3}/src/dataverse_utils/dvdata.py

@@ -116,8 +116,12 @@ class Study(dict): #pylint:  disable=too-few-public-methods
             self.fix_licence()
         if self['source_version'] < 5.013 <= self['target_version']:
             self.fix_production_location()
-        if self['source_version'] < 5.014 <= self['target_version']:
+        if (self['source_version'] < 5.014 <= self['target_version']
+            and self['target_version'] < 6.001):
             self.fix_series()
+        if (self['source_version'] < 5.014 <= self['target_version']
+            and self['target_version'] >= 6.001):
+            self.fix_series(to_series=['series', 'alternativeTitle'])
         if self['source_version'] < 6.008 <= self['target_version']:
             self.fix_geography()
 
@@ -218,6 +222,8 @@ class Study(dict): #pylint:  disable=too-few-public-methods
         if not self['upload_json']['datasetVersion']['termsOfUse']:
             #This shouldn't happen, but UBC has datasets from the early 1970s
             self['upload_json']['datasetVersion']['termsOfUse'] = 'Not available'
+        if self['upload_json']['datasetVersion']['license'] == 'CC0':
+            self['upload_json']['datasetVersion'].update(self.fix_cc0())
 
     def fix_production_location(self)->None:
         '''
@@ -249,11 +255,10 @@ class Study(dict): #pylint:  disable=too-few-public-methods
                                                          ['metadataBlocks']['citation']\
                                                          ['fields'][indy]['value']]
 
-    def fix_series(self)->None:
+    def fix_series(self, to_series=['series'])->None:
         '''
         Turn series into a multiple (as of v5.14)
         '''
-        to_series=['series'] # typeNames which must be converted
         indices = []
         for ind, val in enumerate(self['upload_json']['datasetVersion']\
                                       ['metadataBlocks']['citation']['fields']):
@@ -290,6 +295,29 @@ class Study(dict): #pylint:  disable=too-few-public-methods
             newval['value'].append(newcoord)
             newfields.append(newval)
         self['upload_json']['datasetVersion']['metadataBlocks']['geospatial']['fields'] = newfields
+
+    def fix_cc0(self)->None:
+        '''
+        Returns CC0 licence, post v5.10
+        '''
+
+        cc0='''<p>
+        <img src="https://licensebuttons.net/p/zero/1.0/88x31.png" title="Creative Commons CC0 1.0 Universal Public Domain Dedication. " style="display:none" onload="this.style.display='inline'" />
+        <a href="http://creativecommons.org/publicdomain/zero/1.0" title="Creative Commons CC0 1.0 Universal Public Domain Dedication. " target="_blank">CC0 1.0</a>
+        </p>'''
+        #minimal, uncomment if it becomes a problem
+        ccjson = {'license':{'name': 'CC0 1.0',
+                            'uri': 'http://creativecommons.org/publicdomain/zero/1.0'#,
+                            #'iconUri':	'https://licensebuttons.net/p/zero/1.0/88x31.png',
+                            #'rightsIdentifier':	'CC0-1.0',
+                            #'rightsIdentifierScheme': 'SPDX',
+                            #'schemeUri': 'https://spdx.org/licenses/',
+                            #'languageCode':	'en'
+                             },
+                         'termsOfUse': cc0
+                        }
+        return ccjson
+
     ############
     #END FIXES
     ############