caltechdata-api 1.10.5__tar.gz → 1.11.0__tar.gz

{caltechdata_api-1.10.5 → caltechdata_api-1.11.0}/PKG-INFO

@@ -1,12 +1,11 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: caltechdata_api
-Version: 1.10.5
+Version: 1.11.0
 Summary: Python wrapper for CaltechDATA API.
 Home-page: https://github.com/caltechlibrary/caltechdata_api
 Author: Thomas E Morrell, Rohan Bhattarai, Elizabeth Won, Alexander A Abakah, Kshemaahna Nagi
 Author-email: tmorrell@caltech.edu, aabakah@caltech.edu, knagi@caltech.edu
 License: MIT
-Platform: UNKNOWN
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
@@ -18,6 +17,15 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: datacite>1.1.0
+Requires-Dist: tqdm>=4.62.3
+Requires-Dist: pyyaml
+Requires-Dist: s3fs
+Requires-Dist: cryptography
+Requires-Dist: s3cmd
+Requires-Dist: jsonschema-specifications
+Dynamic: license-file
 
 # CaltechDATA API Python Library
 
@@ -101,5 +109,3 @@ repository will generate junk records that are annoying to delete.
 ## Using the Command Line Interface
 
 If you would like to interact with the CaltechDATA API using the Command line Interface (CLI), please [see the detailed documentation](https://caltechlibrary.github.io/caltechdata_api/caltechdata_api/cli-documentation-for-users).
-
-

{caltechdata_api-1.10.5 → caltechdata_api-1.11.0}/caltechdata_api/caltechdata_edit.py

@@ -1,4 +1,4 @@
-import copy, os, json
+import copy, os, json, time
 
 import requests
 from requests import session
@@ -193,7 +193,14 @@ def caltechdata_edit(
             headers=headers,
         )
         if existing.status_code != 200:
-            raise Exception(f"Record {idv} does not exist, cannot edit")
+            # Try back again to the record
+            existing = requests.get(
+                url + "/api/records/" + idv,
+                headers=headers,
+            )
+
+            if existing.status_code != 200:
+                raise Exception(f"Record {idv} does not exist, cannot edit")
 
     existing = existing.json()
     status = existing["status"]
@@ -326,17 +333,16 @@ def caltechdata_edit(
             # We make a draft
             result = requests.post(
                 url + "/api/records/" + idv + "/draft",
-                json=data,
                 headers=headers,
             )
             if result.status_code != 201:
-                raise Exception(result.text)
-            result = requests.get(
-                url + "/api/records/" + idv,
-                headers=headers,
-            )
-            if result.status_code != 200:
-                raise Exception(result.text)
+                time.sleep(3)
+                result = requests.post(
+                    url + "/api/records/" + idv + "/draft",
+                    headers=headers,
+                )
+                if result.status_code != 201:
+                    raise Exception(result.text)
         # We want files to stay the same as the existing record
         data["files"] = existing["files"]
         if default_preview:
@@ -348,13 +354,23 @@ def caltechdata_edit(
             json=data,
         )
         if result.status_code != 200:
-            raise Exception(result.text)
+            time.sleep(3)
+            result = requests.put(
+                url + "/api/records/" + idv + "/draft",
+                headers=headers,
+                json=data,
+            )
+            if result.status_code != 200:
+                raise Exception(result.text)
 
     if publish:
         publish_link = f"{url}/api/records/{idv}/draft/actions/publish"
         result = requests.post(publish_link, headers=headers)
         if result.status_code != 202:
-            raise Exception(result.text)
+            time.sleep(3)
+            result = requests.post(publish_link, headers=headers)
+            if result.status_code != 202:
+                raise Exception(result.text)
         if return_id:
             return result.json()["id"]
         else:

{caltechdata_api-1.10.5 → caltechdata_api-1.11.0}/caltechdata_api/caltechdata_write.py

@@ -132,16 +132,21 @@ def send_to_community(
     if result.status_code != 202:
         raise Exception(result.text)
     if publish:
-        accept_link = result.json()["links"]["actions"]["accept"]
-        data = comment = {
-            "payload": {
-                "content": "This record is accepted automatically with the CaltechDATA API",
-                "format": "html",
+        if "accept" in result.json()["links"]["actions"]:
+            accept_link = result.json()["links"]["actions"]["accept"]
+            data = comment = {
+                "payload": {
+                    "content": "This record is accepted automatically with the CaltechDATA API",
+                    "format": "html",
+                }
             }
-        }
-        result = requests.post(accept_link, json=data, headers=headers, verify=verify)
-        if result.status_code != 200:
-            raise Exception(result.text)
+            result = requests.post(
+                accept_link, json=data, headers=headers, verify=verify
+            )
+            if result.status_code != 200:
+                raise Exception(result.text)
+        # Otherwise we have direct publish permissions and don't need to acccept
+        # the request
     return result
 
 

{caltechdata_api-1.10.5 → caltechdata_api-1.11.0}/caltechdata_api/cli.py

@@ -173,11 +173,9 @@ def get_funding_details():
     award_number = get_user_input("Enter the award number for funding: ")
     award_exists = check_award_number(award_number)
     if not award_exists:
-        print(
-            f"""Error: No award with number '{award_number}' found in
+        print(f"""Error: No award with number '{award_number}' found in
               CaltechDATA. You will need to provide more details about the
-              funding."""
-        )
+              funding.""")
     award_title = get_user_input("Enter the award title for funding: ")
     while True:
         funder_identifier = get_user_input("Enter the funder ROR (https://ror.org): ")
@@ -185,11 +183,9 @@ def get_funding_details():
         if name:
             break
         else:
-            print(
-                """This funder identifier is not a ROR. Please enter a valid
+            print("""This funder identifier is not a ROR. Please enter a valid
                   ROR identifier (without the url). For example the ROR for the
-                  NSF is 021nxhr62."""
-            )
+                  NSF is 021nxhr62.""")
     print("-" * 10)
     return {
         "awardNumber": award_number,
@@ -349,14 +345,12 @@ def write_s3cmd_config(endpoint):
         access_key = get_user_input("Enter the access key: ")
         secret_key = get_user_input("Enter the secret key: ")
         with open(configf, "w") as file:
-            file.write(
-                f"""[default]
+            file.write(f"""[default]
             access_key = {access_key}
             host_base = {endpoint}
             host_bucket = %(bucket).{endpoint}
             secret_key = {secret_key}
-            """
-            )
+            """)
 
 
 def upload_supporting_file(record_id=None):
@@ -431,11 +425,9 @@ def upload_supporting_file(record_id=None):
                 elif filename in files:
                     file_size = os.path.getsize(filename)
                     if file_size > 1024 * 1024 * 1024:
-                        print(
-                            """The file is greater than 1 GB. Please upload the
+                        print("""The file is greater than 1 GB. Please upload the
                         metadata to CaltechDATA, and you'll be provided
-                        instructions to upload the files to S3 directly."""
-                        )
+                        instructions to upload the files to S3 directly.""")
                     else:
                         filepath = os.path.abspath(filename)
                         filepaths.append(filepath)
@@ -643,12 +635,10 @@ def print_upload_message(rec_id, production):
         if production
         else "https://data.caltechlibrary.dev/uploads/"
     )
-    print(
-        f"""You can view and publish this record at
+    print(f"""You can view and publish this record at
         {base_url}{rec_id}
         If you need to upload large files to S3, you can type
-        `s3cmd put DATA_FILE s3://ini230004-bucket01/{rec_id}/`"""
-    )
+        `s3cmd put DATA_FILE s3://ini230004-bucket01/{rec_id}/`""")
 
 
 def edit_record(production):

caltechdata_api-1.11.0/caltechdata_api/vocabularies/date_types.yaml

@@ -0,0 +1,55 @@
+- id: accepted
+  props:
+    datacite: Accepted
+  title:
+    en: Accepted
+- id: available
+  props:
+    datacite: Available
+  title:
+    en: Available
+- id: collected
+  props:
+    datacite: Collected
+  title:
+    en: Collected
+- id: copyrighted
+  props:
+    datacite: Copyrighted
+  title:
+    en: Copyrighted
+- id: created
+  props:
+    datacite: Created
+  title:
+    en: Created
+- id: issued
+  props:
+    datacite: Issued
+  title:
+    en: Issued
+- id: other
+  props:
+    datacite: Other
+  title:
+    en: Other
+- id: submitted
+  props:
+    datacite: Submitted
+  title:
+    en: Submitted
+- id: updated
+  props:
+    datacite: Updated
+  title:
+    en: Updated
+- id: valid
+  props:
+    datacite: Valid
+  title:
+    en: Valid
+- id: withdrawn
+  props:
+    datacite: Withdrawn
+  title:
+    en: Withdrawn

caltechdata_api-1.11.0/caltechdata_api/vocabularies/description_types.yaml

@@ -0,0 +1,34 @@
+- id: abstract
+  props:
+    datacite: Abstract
+  title:
+    en: Abstract
+- id: methods
+  props:
+    datacite: Methods
+  title:
+    en: Methods
+- id: series-information
+  props:
+    datacite: SeriesInformation
+  title:
+    en: Series information
+- id: table-of-contents
+  props:
+    datacite: TableOfContents
+  title:
+    en: Table of contents
+- id: technical-info
+  props:
+    datacite: TechnicalInfo
+  title:
+    en: Technical info
+- id: other
+  props:
+    datacite: Other
+  title:
+    en: Other
+# Not really a datacite mapping, but needed to support passing custom types
+- id: files
+  props:
+    datacite: files

caltechdata_api-1.11.0/caltechdata_api/vocabularies/identifier_types.yaml

@@ -0,0 +1,110 @@
+- id: ark
+  props:
+    datacite: ARK
+  title:
+    en: ARK
+- id: arxiv
+  props:
+    datacite: arXiv
+  title:
+    en: arXiv
+- id: bibcode
+  props:
+    datacite: bibcode
+  title:
+    en: Bibcode
+- id: doi
+  props:
+    datacite: DOI
+  title:
+    en: DOI
+- id: ean13
+  props:
+    datacite: EAN13
+  title:
+    en: EAN13
+- id: eissn
+  props:
+    datacite: EISSN
+  title:
+    en: EISSN
+- id: handle
+  props:
+    datacite: Handle
+  title:
+    en: Handle
+- id: igsn
+  props:
+    datacite: IGSN
+  title:
+    en: IGSN
+- id: isbn
+  props:
+    datacite: ISBN
+  title:
+    en: ISBN
+- id: issn
+  props:
+    datacite: ISSN
+  title:
+    en: ISSN
+- id: istc
+  props:
+    datacite: ISTC
+  title:
+    en: ISTC
+- id: lissn
+  props:
+    datacite: LISSN
+  title:
+    en: LISSN
+- id: lsid
+  props:
+    datacite: LSID
+  title:
+    en: LSID
+- id: pmid
+  props:
+    datacite: PMID
+  title:
+    en: PMID
+- id: purl
+  props:
+    datacite: PURL
+  title:
+    en: PURL
+- id: upc
+  props:
+    datacite: UPC
+  title:
+    en: UPC
+- id: url
+  props:
+    datacite: URL
+  title:
+    en: URL
+- id: urn
+  props:
+    datacite: URN
+  title:
+    en: URN
+- id: w3id
+  props:
+    datacite: w3id
+  title:
+    en: W3ID
+- id: cdid
+  props:
+    datacite: cdid
+  title:
+    en: CALTECHDATA_ID
+- id: tiltid
+  props:
+    datacite: tiltid
+  title:
+    en: TILT_SERIES_ID
+- id: dsa-110-id
+  props:
+    datacite: dsa-110-id
+  title:
+    en: DSA_110_ID