Fix language to reflect Dataverse 4.0

Author: rliebz

dataverse/__init__.py

@@ -1,6 +1,6 @@
 from connection import Connection
 from dataverse import Dataverse
-from study import Study
+from dataset import Dataset
 from file import DataverseFile
 
 from utils import DataverseException

dataverse/study.py dataverse/dataset.pydataverse/study.py renamed to dataverse/dataset.py

@@ -13,7 +13,7 @@
 )
 
 
-class Study(object):
+class Dataset(object):
     def __init__(self, entry=SWORD_BOOTSTRAP, dataverse=None, edit_uri=None,
                  edit_media_uri=None, statement_uri=None, **kwargs):
         """
@@ -104,7 +104,7 @@ def get_statement(self, refresh=False):
             return self._statement
 
         if not self.connection:
-            raise DataverseException('This study has not been added to a Dataverse.')
+            raise DataverseException('This dataset has not been added to a Dataverse.')
 
         if not self.statement_uri:
             # Try to find statement uri without a request to the server
@@ -144,31 +144,31 @@ def get_state(self, refresh=False):
         ).text
         return self._state
 
-    def get_file(self, file_name, released=False):
+    def get_file(self, file_name, published=False):
 
-        # Search released study if specified; otherwise, search draft
-        files = self.get_released_files() if released else self.get_files()
+        # Search published dataset if specified; otherwise, search draft
+        files = self.get_published_files() if published else self.get_files()
         return next((f for f in files if f.name == file_name), None)
 
-    def get_file_by_id(self, file_id, released=False):
+    def get_file_by_id(self, file_id, published=False):
 
-        # Search released study if specified; otherwise, search draft
-        files = self.get_released_files() if released else self.get_files()
+        # Search published dataset if specified; otherwise, search draft
+        files = self.get_published_files() if published else self.get_files()
         return next((f for f in files if f.id == file_id), None)
 
-    def get_files(self, released=False, refresh=True):
-        if released:
-            return self.get_released_files()
+    def get_files(self, published=False, refresh=True):
+        if published:
+            return self.get_published_files()
 
         return [
             DataverseFile.from_statement(resource, self)
             for resource in get_elements(self.get_statement(refresh), 'entry')
         ]
 
-    def get_released_files(self):
+    def get_published_files(self):
         """
         Uses data sharing API to retrieve a list of files from the most
-        recently released version of the study
+        recently published version of the dataset
         """
         metadata_url = 'https://{0}/dvn/api/metadata/{1}'.format(
             self.connection.host, self.doi
@@ -220,23 +220,23 @@ def upload_file(self, filename, content, zip=True):
 
         self._refresh()
 
-    def release(self):
+    def publish(self):
         resp = requests.post(
             self.edit_uri,
             headers={'In-Progress': 'false', 'Content-Length': 0},
             auth=self.connection.auth,
         )
 
         if resp.status_code != 200:
-            raise DataverseException('The Dataverse could not be released.')
+            raise DataverseException('The Dataverse could not be published.')
 
         receipt = resp.content
         self._refresh(receipt=receipt)
 
     def delete_file(self, dataverse_file):
-        if dataverse_file.is_released:
+        if dataverse_file.is_published:
             raise DataverseException(
-                'Released versions of files cannot be deleted.'
+                'Published versions of files cannot be deleted.'
             )
 
         resp = requests.delete(
@@ -261,7 +261,7 @@ def delete_all_files(self):
     #     )
     #     self._refresh(deposit_receipt=depositReceipt)
 
-    # if we perform a server operation, we should refresh the study object
+    # if we perform a server operation, we should refresh the dataset object
     def _refresh(self, receipt=None):
         if receipt:
             self.edit_uri = get_element(

dataverse/dataverse.py

@@ -1,6 +1,6 @@
 import requests
 
-from study import Study
+from dataset import Dataset
 from utils import get_element, get_elements, DataverseException, sanitize
 
 
@@ -10,7 +10,7 @@ def __init__(self, connection, collection):
         self.collection = collection
 
     @property
-    def is_released(self):
+    def is_published(self):
 
         collection_info = requests.get(
             self.collection.get('href'),
@@ -38,7 +38,7 @@ def title(self):
             tag='title',
         ).text)
 
-    def release(self):
+    def publish(self):
         edit_uri = 'https://{0}/dvn/api/data-deposit/v1.1/swordv2/edit/dataverse/{1}'.format(
             self.connection.host, self.alias
         )
@@ -49,45 +49,45 @@ def release(self):
         )
 
         if resp.status_code != 200:
-            raise DataverseException('The Dataverse could not be released.')
+            raise DataverseException('The Dataverse could not be published.')
 
-    def add_study(self, study):
+    def add_dataset(self, dataset):
 
-        if get_element(study._entry, 'title', 'dcterms') is None:
-            raise DataverseException('This study must have a title.')
-        if get_element(study._entry, 'description', 'dcterms') is None:
-            raise DataverseException('This study must have a description.')
-        if get_element(study._entry, 'creator', 'dcterms') is None:
-            raise DataverseException('This study must have an author.')
+        if get_element(dataset._entry, 'title', 'dcterms') is None:
+            raise DataverseException('This dataset must have a title.')
+        if get_element(dataset._entry, 'description', 'dcterms') is None:
+            raise DataverseException('This dataset must have a description.')
+        if get_element(dataset._entry, 'creator', 'dcterms') is None:
+            raise DataverseException('This dataset must have an author.')
 
         resp = requests.post(
             self.collection.get('href'),
-            data=study.get_entry(),
+            data=dataset.get_entry(),
             headers={'Content-type': 'application/atom+xml'},
             auth=self.connection.auth,
         )
 
         if resp.status_code != 201:
-            raise DataverseException('This study could not be added.')
+            raise DataverseException('This dataset could not be added.')
 
-        study.dataverse = self
-        study._refresh(receipt=resp.content)
+        dataset.dataverse = self
+        dataset._refresh(receipt=resp.content)
 
-    def delete_study(self, study):
+    def delete_dataset(self, dataset):
 
-        if study._state == 'DELETED' or study._state == 'DEACCESSIONED':
-            raise DataverseException('This study has already been deleted.')
+        if dataset._state == 'DELETED' or dataset._state == 'DEACCESSIONED':
+            raise DataverseException('This dataset has already been deleted.')
 
         resp = requests.delete(
-            study.edit_uri,
+            dataset.edit_uri,
             auth=self.connection.auth,
         )
         if resp.status_code == 405:
-            raise DataverseException('Released studies can only be deleted '
+            raise DataverseException('Published studies can only be deleted '
                 'from the GUI. For more information, please refer to '
                 'https://github.com/IQSS/dataverse/issues/778')
 
-        study._state = 'DEACCESSIONED'
+        dataset._state = 'DEACCESSIONED'
 
     def get_studies(self):
 
@@ -97,13 +97,13 @@ def get_studies(self):
         ).content
 
         entries = get_elements(collection_info, tag='entry')
-        return [Study.from_dataverse(entry, self) for entry in entries]
+        return [Dataset.from_dataverse(entry, self) for entry in entries]
 
-    def get_study_by_doi(self, doi):
+    def get_dataset_by_doi(self, doi):
         return next((s for s in self.get_studies() if s.doi == doi), None)
 
-    def get_study_by_title(self, title):
+    def get_dataset_by_title(self, title):
         return next((s for s in self.get_studies() if s.title == title), None)
 
-    def get_study_by_string_in_entry(self, string):
+    def get_dataset_by_string_in_entry(self, string):
         return next((s for s in self.get_studies() if string in s.get_entry()), None)

dataverse/file.py

@@ -4,20 +4,20 @@
 
 
 class DataverseFile(object):
-    def __init__(self, name, study, edit_media_uri=None, download_url=None):
+    def __init__(self, name, dataset, edit_media_uri=None, download_url=None):
         self.name = sanitize(name)
-        self.study = study
+        self.dataset = dataset
 
         if edit_media_uri:
-            self.is_released = False
+            self.is_published = False
             self.edit_media_uri = edit_media_uri
             self.id = edit_media_uri.split('/')[-2]
             host = urlparse.urlparse(edit_media_uri).netloc
             self.download_url = 'http://{0}/api/access/datafile/{1}'.format(
                 host, self.id
             )
         elif download_url:
-            self.is_released = True
+            self.is_published = True
             self.download_url = download_url
             self.id = download_url.split('=')[-1]
         else:
@@ -36,17 +36,17 @@ def __repr__(self):
             self.name,
             self.id,
             self.download_url,
-            'RELEASED' if self.is_released else 'DRAFT',
+            'PUBLISHED' if self.is_published else 'DRAFT',
         )
 
     @classmethod
-    def from_statement(cls, element, study):
+    def from_statement(cls, element, dataset):
         edit_media_uri = get_element(element, 'content').get('src')
         name = edit_media_uri.rsplit("/")[-1]
-        return cls(name, study, edit_media_uri=edit_media_uri)
+        return cls(name, dataset, edit_media_uri=edit_media_uri)
 
     @classmethod
-    def from_metadata(cls, element, study):
+    def from_metadata(cls, element, dataset):
         name = element[0].text
         download_url = element.attrib.get('URI')
-        return cls(name, study, download_url=download_url)
+        return cls(name, dataset, download_url=download_url)

dataverse/test/config.py

@@ -1,9 +1,9 @@
-PICS_OF_CATS_STUDY = {
+PICS_OF_CATS_DATASET = {
     "id": "1",
     "title": "This Study is about Pictures of Cats",
     "author": "Peter Bull",
     "description": "In this study we prove there can be pictures of cats.",
 }
 
-ATOM_STUDY = "../resources/atom-entry-study.xml"
+ATOM_DATASET = "../resources/atom-entry-study.xml"