caltechdata-api 1.9.1__tar.gz → 1.10.0__tar.gz

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.1
 Name: caltechdata_api
-Version: 1.9.1
+Version: 1.10.0
 Summary: Python wrapper for CaltechDATA API.
 Home-page: https://github.com/caltechlibrary/caltechdata_api
-Author: Thomas E Morrell, Bhattarai Rohan , Won Elizabeth
-Author-email: tmorrell@caltech.edu, , 
-License: https://data.caltech.edu/license
+Author: Thomas E Morrell, Rohan Bhattarai, Elizabeth Won, Alexander A Abakah
+Author-email: tmorrell@caltech.edu, aabakah@caltech.edu
+License: MIT
 Platform: UNKNOWN
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-
 # CaltechDATA API Python Library
 
 [![DOI](https://img.shields.io/badge/dynamic/json.svg?label=DOI&query=$.pids.doi.identifier&uri=https://data.caltech.edu/api/records/wfjr5-kw507/versions/latest)](https://data.caltech.edu/records/wfjr5-kw507/latest)
@@ -49,7 +50,7 @@ pip install caltechdata_api
 
 There are some example python scripts in the GitHub repository.
 
-###Create a record:
+### Create a record:
 
 ```shell
 python write.py example.json -fnames logo.gif
@@ -59,7 +60,7 @@ python write.py example.json -fnames logo.gif
 the end of a url to visit the record (e.g.
 https://data.caltechlibrary.dev/records/pbkn6-m9y63)
 
-###Edit a record 
+### Edit a record 
 Make changes to the example.json file to see a change)
 ```
 python edit.py example.json -id pbkn6-m9y63

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/README.md

@@ -29,7 +29,7 @@ pip install caltechdata_api
 
 There are some example python scripts in the GitHub repository.
 
-###Create a record:
+### Create a record:
 
 ```shell
 python write.py example.json -fnames logo.gif
@@ -39,7 +39,7 @@ python write.py example.json -fnames logo.gif
 the end of a url to visit the record (e.g.
 https://data.caltechlibrary.dev/records/pbkn6-m9y63)
 
-###Edit a record 
+### Edit a record 
 Make changes to the example.json file to see a change)
 ```
 python edit.py example.json -id pbkn6-m9y63

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/caltechdata_api/__init__.py

@@ -9,7 +9,8 @@ from .caltechdata_edit import (
     caltechdata_unembargo,
     caltechdata_accept,
 )
-from .customize_schema import customize_schema
+from .customize_schema import customize_schema, validate_metadata
 from .get_metadata import get_metadata
 from .download_file import download_file, download_url
 from .utils import humanbytes
+from .md_to_json import parse_readme_to_json

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/caltechdata_api/caltechdata_edit.py

@@ -66,6 +66,7 @@ def caltechdata_edit(
     default_preview=None,
     authors=False,
     keepfiles=False,
+    return_id=False,
 ):
     # Make a copy of the metadata to make sure our local changes don't leak
     metadata = copy.deepcopy(metadata)
@@ -299,10 +300,13 @@ def caltechdata_edit(
         result = requests.post(publish_link, headers=headers)
         if result.status_code != 202:
             raise Exception(result.text)
-        pids = result.json()["pids"]
-        if "doi" in pids:
-            return pids["doi"]["identifier"]
+        if return_id:
+            return result.json()["id"]
         else:
-            return pids["oai"]["identifier"]
+            pids = result.json()["pids"]
+            if "doi" in pids:
+                return pids["doi"]["identifier"]
+            else:
+                return pids["oai"]["identifier"]
     else:
         return idv

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/caltechdata_api/cli.py

@@ -1,8 +1,7 @@
 import argparse
 import requests
 import s3fs
-from caltechdata_api import caltechdata_write, caltechdata_edit
-from md_to_json import parse_readme_to_json
+from caltechdata_api import caltechdata_write, caltechdata_edit, parse_readme_to_json
 import json
 import os
 from cryptography.fernet import Fernet
@@ -59,11 +58,17 @@ def decrypt_token(encrypted_token, key):
     return f.decrypt(encrypted_token).decode()
 
 
-# Function to get or set token with support for test system
+# Function to get or set token with support for test system.
 def get_or_set_token(production=True):
+    # First check for environment variable
+    env_token = os.environ.get("CALTECHDATA_TOKEN")
+    if env_token:
+        print("Using token from environment variable")
+        return env_token
+
     key = load_or_generate_key()
 
-    # Use different token files for production and test environments
+    # Use different token files for production and test environment.
     token_filename = "token.txt" if production else "token_test.txt"
     token_file = os.path.join(caltechdata_directory, token_filename)
 
@@ -94,6 +99,16 @@ def get_or_set_token(production=True):
                 print("Tokens do not match. Please try again.")
 
 
+# Delete the saved token file.
+def delete_saved_token():
+    token_file = os.path.join(caltechdata_directory, "token.txt")
+    if os.path.exists(token_file):
+        os.remove(token_file)
+        print("Token deleted successfully.")
+    else:
+        print("No token found to delete.")
+
+
 def welcome_message():
     print("Welcome to CaltechDATA CLI")
 
@@ -181,6 +196,61 @@ def get_funding_details():
     }
 
 
+# Add profile handling functions
+def save_profile():
+    profile_file = os.path.join(caltechdata_directory, "profile.json")
+
+    # Get ORCID
+    while True:
+        orcid = get_user_input("Enter your ORCID identifier: ")
+        orcid = normalize_orcid(orcid)
+        family_name, given_name = get_names(orcid)
+        if family_name is not None and given_name is not None:
+            break
+        retry = input("Do you want to try again? (y/n): ")
+        if retry.lower() != "y":
+            return None
+
+    # Get funding details
+    funding_references = []
+    num_funding_entries = get_funding_entries()
+    for _ in range(num_funding_entries):
+        funding_references.append(get_funding_details())
+
+    profile_data = {
+        "orcid": orcid,
+        "family_name": family_name,
+        "given_name": given_name,
+        "funding_references": funding_references,
+    }
+
+    with open(profile_file, "w") as f:
+        json.dump(profile_data, f, indent=2)
+
+    print("Profile saved successfully!")
+    return profile_data
+
+
+def load_profile():
+    profile_file = os.path.join(caltechdata_directory, "profile.json")
+    try:
+        with open(profile_file, "r") as f:
+            return json.load(f)
+    except FileNotFoundError:
+        return None
+
+
+def get_or_create_profile():
+    profile = load_profile()
+    if profile:
+        use_saved = input("Use saved profile? (y/n): ").lower()
+        if use_saved == "y":
+            return profile
+
+    print("Creating new profile...")
+    return save_profile()
+
+
 def parse_arguments():
     welcome_message()
     args = {}
@@ -217,23 +287,17 @@ def parse_arguments():
             break
         else:
             print("Invalid input. Please enter a number between 1 and 8.")
+    # Load or create profile
+    profile = get_or_create_profile()
+    if profile:
+        args["orcid"] = profile["orcid"]
+        args["family_name"] = profile["family_name"]
+        args["given_name"] = profile["given_name"]
+        args["fundingReferences"] = profile["funding_references"]
+    else:
+        print("Failed to load or create profile. Exiting.")
+        return None
 
-    while True:
-        orcid = get_user_input("Enter your ORCID identifier: ")
-        family_name, given_name = get_names(orcid)
-        if family_name is not None and given_name is not None:
-            args["orcid"] = orcid
-            break  # Break out of the loop if names are successfully retrieved
-        retry = input("Do you want to try again? (y/n): ")
-        if retry.lower() != "y":
-            print("Exiting program.")
-            return
-    # Optional arguments
-    num_funding_entries = get_funding_entries()
-    funding_references = []
-    for _ in range(num_funding_entries):
-        funding_references.append(get_funding_details())
-    args["fundingReferences"] = funding_references
     return args
 
 
@@ -405,24 +469,48 @@ def parse_args():
     parser.add_argument(
         "-test", action="store_true", help="Use test mode, sets production to False"
     )
+    parser.add_argument(
+        "--delete-token", action="store_true", help="Delete the saved token."
+    )
     args = parser.parse_args()
     return args
 
 
+def normalize_orcid(val):
+    orcid_urls = ["https://orcid.org/", "http://orcid.org/", "orcid.org/"]
+    for orcid_url in orcid_urls:
+        if val.startswith(orcid_url):
+            val = val[len(orcid_url) :]
+            break
+
+    val = val.replace("-", "").replace(" ", "")
+    if len(val) != 16 or not val.isdigit():
+        raise ValueError(f"Invalid ORCID identifier: {val}")
+    return "-".join([val[0:4], val[4:8], val[8:12], val[12:16]])
+
+
 def main():
     args = parse_args()
+    production = not args.test
+    if args.delete_token:
+        delete_saved_token()
+    while True:
+        choice = get_user_input(
+            "What would you like to do? (create/edit/profile/exit): "
+        ).lower()
 
-    production = not args.test  # Set production to False if -test flag is provided
-
-    choice = get_user_input(
-        "Do you want to create or edit a CaltechDATA record? (create/edit): "
-    ).lower()
-    if choice == "create":
-        create_record(production)
-    elif choice == "edit":
-        edit_record(production)
-    else:
-        print("Invalid choice. Please enter 'create' or 'edit'.")
+        if choice == "create":
+            create_record(production)
+        elif choice == "edit":
+            edit_record(production)
+        elif choice == "profile":
+            save_profile()
+        elif choice == "exit":
+            break
+        else:
+            print(
+                "Invalid choice. Please enter 'create', 'edit', 'profile', or 'exit'."
+            )
 
 
 def create_record(production):
@@ -521,6 +609,7 @@ def create_record(production):
                 print_upload_message(rec_id, production)
                 with open(response + ".json", "w") as file:
                     json.dump(metadata, file, indent=2)
+                exit()
                 break
             else:
                 break

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/caltechdata_api/customize_schema.py

@@ -373,7 +373,8 @@ def customize_schema_rdm(json_record):
     if "community" in json_record:
         com = json_record.pop("community")
         parent["communities"] = {"ids": [com], "default": com}
-    final["parent"] = parent
+    if parent != {}:
+        final["parent"] = parent
     # Not technically datacite, but transfer pids information
     if "pids" in json_record:
         final["pids"] = json_record.pop("pids")
@@ -408,11 +409,11 @@ def validate_metadata(json_record):
 
     # Publication date is handled by customize function
 
-    # Check for 'resourceType'
-    if "resourceType" not in json_record["types"]:
-        errors.append("'resourceType' field is missing in 'types'.")
-    elif not isinstance(json_record["types"]["resourceType"], str):
-        errors.append("'resourceType' should be a string.")
+    # Check for 'resourceTypeGeneral'
+    if "resourceTypeGeneral" not in json_record["types"]:
+        errors.append("'resourceTypeGeneral' field is missing in 'types'.")
+    elif not isinstance(json_record["types"]["resourceTypeGeneral"], str):
+        errors.append("'resourceTypeGeneral' should be a string.")
 
     # Check for 'identifiers'
     if "identifiers" in json_record:
@@ -480,18 +481,17 @@ def validate_metadata(json_record):
                     errors.append("Each 'subject' must have a 'subject' key.")
 
     # Check for 'dates'
-    if "dates" not in json_record:
-        errors.append("'dates' field is missing.")
-    elif not isinstance(json_record["dates"], list) or len(json_record["dates"]) == 0:
-        errors.append("'dates' should be a non-empty list.")
-    else:
-        for date in json_record["dates"]:
-            if (
-                not isinstance(date, dict)
-                or "date" not in date
-                or "dateType" not in date
-            ):
-                errors.append("Each 'date' must have 'date' and 'dateType'.")
+    if "dates" in json_record:
+        if not isinstance(json_record["dates"], list) or len(json_record["dates"]) == 0:
+            errors.append("'dates' should be a non-empty list.")
+        else:
+            for date in json_record["dates"]:
+                if (
+                    not isinstance(date, dict)
+                    or "date" not in date
+                    or "dateType" not in date
+                ):
+                    errors.append("Each 'date' must have 'date' and 'dateType'.")
 
     # Check for 'creators'
     if "creators" not in json_record:
@@ -509,11 +509,11 @@ def validate_metadata(json_record):
                 if creator["nameType"] == "Organizational":
                     if "name" not in creator:
                         errors.append("Each organizational 'creator' must have 'name'.")
-            else:
-                if "familyName" not in creator:
-                    errors.append(
-                        "Each 'creator' must have a 'familyName' or have type Organizational"
-                    )
+                else:
+                    if "familyName" not in creator:
+                        errors.append(
+                            "Each 'creator' must have a 'familyName' or have type Organizational"
+                        )
             if "affiliation" in creator:
                 if not isinstance(creator["affiliation"], list):
                     errors.append("'affiliation' in 'creators' should be a list.")
@@ -601,10 +601,9 @@ def validate_metadata(json_record):
         errors.append("'publisher' should be a string.")
 
     # Check for 'publicationYear'
-    if "publicationYear" not in json_record:
-        errors.append("'publicationYear' field is missing.")
-    elif not isinstance(json_record["publicationYear"], str):
-        errors.append("'publicationYear' should be a string.")
+    if "publicationYear" in json_record:
+        if not isinstance(json_record["publicationYear"], str):
+            errors.append("'publicationYear' should be a string.")
 
     # Check for 'types'
     if "types" not in json_record:

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/caltechdata_api.egg-info/PKG-INFO

@@ -1,23 +1,24 @@
 Metadata-Version: 2.1
 Name: caltechdata-api
-Version: 1.9.1
+Version: 1.10.0
 Summary: Python wrapper for CaltechDATA API.
 Home-page: https://github.com/caltechlibrary/caltechdata_api
-Author: Thomas E Morrell, Bhattarai Rohan , Won Elizabeth
-Author-email: tmorrell@caltech.edu, , 
-License: https://data.caltech.edu/license
+Author: Thomas E Morrell, Rohan Bhattarai, Elizabeth Won, Alexander A Abakah
+Author-email: tmorrell@caltech.edu, aabakah@caltech.edu
+License: MIT
 Platform: UNKNOWN
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-
 # CaltechDATA API Python Library
 
 [![DOI](https://img.shields.io/badge/dynamic/json.svg?label=DOI&query=$.pids.doi.identifier&uri=https://data.caltech.edu/api/records/wfjr5-kw507/versions/latest)](https://data.caltech.edu/records/wfjr5-kw507/latest)
@@ -49,7 +50,7 @@ pip install caltechdata_api
 
 There are some example python scripts in the GitHub repository.
 
-###Create a record:
+### Create a record:
 
 ```shell
 python write.py example.json -fnames logo.gif
@@ -59,7 +60,7 @@ python write.py example.json -fnames logo.gif
 the end of a url to visit the record (e.g.
 https://data.caltechlibrary.dev/records/pbkn6-m9y63)
 
-###Edit a record 
+### Edit a record 
 Make changes to the example.json file to see a change)
 ```
 python edit.py example.json -id pbkn6-m9y63

{caltechdata_api-1.9.1 → caltechdata_api-1.10.0}/caltechdata_api.egg-info/SOURCES.txt

@@ -1,5 +1,7 @@
 LICENSE
 README.md
+pyproject.toml
+setup.cfg
 setup.py
 caltechdata_api/__init__.py
 caltechdata_api/caltechdata_edit.py

caltechdata_api-1.10.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

caltechdata_api-1.10.0/setup.cfg

@@ -0,0 +1,54 @@
+[build-system]
+requires = ["setuptools>=64.0","wheel"]
+build-backend = "setuptools.build_meta"
+
+[metadata]
+name = caltechdata_api
+version = 1.10.0
+author = Thomas E Morrell, Rohan Bhattarai, Elizabeth Won, Alexander A Abakah
+author_email = tmorrell@caltech.edu, aabakah@caltech.edu
+description = Python wrapper for CaltechDATA API.
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/caltechlibrary/caltechdata_api
+license = MIT
+classifiers = 
+	License :: OSI Approved :: MIT License
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.7
+	Programming Language :: Python :: 3.8
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: Implementation :: CPython
+	Operating System :: OS Independent
+
+[options]
+packages = find:
+python_requires = >=3.6.0
+install_requires = 
+	requests
+	datacite>1.1.0
+	tqdm>=4.62.3
+	pyyaml
+	s3fs
+	cryptography
+	s3cmd
+include_package_data = True
+
+[options.packages.find]
+exclude = tests
+
+[options.package_data]
+caltechdata_api = vocabularies.yaml, vocabularies/*
+
+[options.entry_points]
+console_scripts = 
+	caltechdata_api=caltechdata_api.cli:main
+
+[tool:pytest]
+addopts = --verbose
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

caltechdata_api-1.10.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

caltechdata_api-1.9.1/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

caltechdata_api-1.9.1/setup.py

@@ -1,179 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-# Note: To use the 'upload' functionality of this file, you must:
-#   $ pip install twine
-
-import io, json
-import os
-import sys
-import glob
-from shutil import rmtree
-
-from setuptools import find_packages, setup, Command
-
-
-def read(fname):
-    with open(fname, mode="r", encoding="utf-8") as f:
-        src = f.read()
-    return src
-
-
-def package_files(package, directory):
-    os.chdir(package)
-    paths = glob.glob(directory + "/**", recursive=True)
-    os.chdir("..")
-    return paths
-
-
-codemeta_json = "codemeta.json"
-
-# Let's pickup as much metadata as we need from codemeta.json
-with open(codemeta_json, mode="r", encoding="utf-8") as f:
-    src = f.read()
-    meta = json.loads(src)
-
-# Let's make our symvar string
-version = meta["version"]
-
-# Now we need to pull and format our author, author_email strings.
-author = ""
-author_email = ""
-for obj in meta["author"]:
-    given = obj.get("givenName", "")
-    family = obj.get("familyName", "")
-    email = obj.get("email", "")
-    if len(author) == 0:
-        author = given + " " + family
-    else:
-        author = author + ", " + given + " " + family
-    if len(author_email) == 0:
-        author_email = email
-    else:
-        author_email = author_email + ", " + email
-description = meta["description"]
-url = meta["codeRepository"]
-download = meta["downloadUrl"]
-license = meta["license"]
-name = meta["name"]
-
-REQUIRES_PYTHON = ">=3.6.0"
-
-# What packages are required for this module to be executed?
-REQUIRED = [
-    "requests",
-    "datacite>1.1.0",
-    "tqdm>=4.62.3",
-    "pyyaml",
-    "s3fs",
-    "cryptography",
-    "s3cmd",
-]
-
-# What packages are optional?
-EXTRAS = {
-    # 'fancy feature': ['django'],
-}
-
-files = package_files("caltechdata_api", "vocabularies")
-files.append("vocabularies.yaml")
-
-# The rest you shouldn't have to touch too much :)
-# ------------------------------------------------
-# Except, perhaps the License and Trove Classifiers!
-# If you do change the License, remember to change the Trove Classifier for that!
-
-here = os.path.abspath(os.path.dirname(__file__))
-
-# Import the README and use it as the long-description.
-# Note: this will only work if 'README.md' is present in your MANIFEST.in file!
-try:
-    with io.open(os.path.join(here, "README.md"), encoding="utf-8") as f:
-        long_description = "\n" + f.read()
-except FileNotFoundError:
-    long_description = description
-
-# Load the package's __version__.py module as a dictionary.
-about = {}
-if not version:
-    with open(os.path.join(here, NAME, "__version__.py")) as f:
-        exec(f.read(), about)
-else:
-    about["__version__"] = version
-
-
-class UploadCommand(Command):
-    """Support setup.py upload."""
-
-    description = "Build and publish the package."
-    user_options = []
-
-    @staticmethod
-    def status(s):
-        """Prints things in bold."""
-        print("\033[1m{0}\033[0m".format(s))
-
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
-    def run(self):
-        try:
-            self.status("Removing previous builds…")
-            rmtree(os.path.join(here, "dist"))
-        except OSError:
-            pass
-
-        self.status("Building Source and Wheel distribution…")
-        os.system("{0} setup.py sdist bdist_wheel ".format(sys.executable))
-
-        self.status("Uploading the package to PyPI via Twine…")
-        os.system("twine upload dist/*")
-
-        sys.exit()
-
-
-# Where the magic happens:
-setup(
-    name=name,
-    version=about["__version__"],
-    description=description,
-    long_description=long_description,
-    long_description_content_type="text/markdown",
-    author=author,
-    author_email=author_email,
-    python_requires=REQUIRES_PYTHON,
-    url=url,
-    packages=find_packages(exclude=("tests",)),
-    # If your package is a single module, use this instead of 'packages':
-    # py_modules=['mypackage'],
-    # entry_points={
-    #     'console_scripts': ['mycli=mymodule:cli'],
-    # },
-    install_requires=REQUIRED,
-    extras_require=EXTRAS,
-    include_package_data=True,
-    package_data={name: files},
-    license=license,
-    classifiers=[
-        # Trove classifiers
-        # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers
-        "License :: OSI Approved :: BSD License",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: Implementation :: CPython",
-        "Programming Language :: Python :: Implementation :: PyPy",
-    ],
-    # $ setup.py publish support.
-    cmdclass={
-        "upload": UploadCommand,
-    },
-    entry_points={
-        "console_scripts": [
-            "caltechdata_api=caltechdata_api.cli:main",
-        ],
-    },
-)