caltechdata-api 2.0.0__tar.gz → 2.1.0__tar.gz

{caltechdata_api-2.0.0 → caltechdata_api-2.1.0}/PKG-INFO

@@ -1,20 +1,25 @@
 Metadata-Version: 2.4
 Name: caltechdata_api
-Version: 2.0.0
+Version: 2.1.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
-Classifier: License :: OSI Approved :: MIT License
+Author: Rohan Bhattarai, Elizabeth Won
+Author-email: Thomas E Morrell <tmorrell@caltech.edu>, Alexander A Abakah <aabakah@caltech.edu>, Kshemaahna Nagi <knagi@caltech.edu>
+Maintainer-email: Thomas E Morrell <tmorrell@caltech.edu>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/caltechlibrary/caltechdata_api
+Project-URL: Repository, https://github.com/caltechlibrary/caltechdata_api
+Project-URL: Issues, https://github.com/caltechlibrary/caltechdata_api/issues
+Keywords: metadata,software,InvenioRDM
 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 :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6.0
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -44,7 +49,7 @@ The `caltechdata_api` Python library provides a convenient interface for interac
 
 ## Requirements
 
-- Python 3.6+
+- Python 3.9+
 
 ## Installation
 
@@ -54,6 +59,18 @@ Install the library via pip:
 pip install caltechdata_api
 ```
 
+Or add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```shell
+uv add caltechdata_api
+```
+
+You can also run a script using uv:
+
+```shell
+uv run write.py
+```
+
 ## Examples
 
 There are some example python scripts in the GitHub repository.
@@ -61,7 +78,7 @@ There are some example python scripts in the GitHub repository.
 ### Create a record:
 
 ```shell
-python write.py example.json -fnames logo.gif
+uv run write.py example.json -fnames logo.gif
 # Output: pbkn6-m9y63 (unique identifier)
 ```
 > The response will be the unique identifier for the record. You can put this at
@@ -71,7 +88,7 @@ https://data.caltechlibrary.dev/records/pbkn6-m9y63)
 ### Edit a record 
 Make changes to the example.json file to see a change)
 ```
-python edit.py example.json -id pbkn6-m9y63
+uv run edit.py example.json -id pbkn6-m9y63
 10.33569/pbkn6-m9y63
 ```
 > The response is the DOI for the record, which includes the unique identifier
@@ -82,13 +99,13 @@ Some groups have worked with the library to create custom DOIs. These can be
 passed in the metadata like:
 
 ```shell
-python write.py example_custom.json -fnames logo.gif
+uv run write.py example_custom.json -fnames logo.gif
 m6zxz-p4j22
 ```
 
 And then you can edit with
 ```
-python edit.py example_custom.json -id m6zxz-p4j22
+uv run edit.py example_custom.json -id m6zxz-p4j22
 10.5281/inveniordm.1234
 ```
 

{caltechdata_api-2.0.0 → caltechdata_api-2.1.0}/README.md

@@ -15,7 +15,7 @@ The `caltechdata_api` Python library provides a convenient interface for interac
 
 ## Requirements
 
-- Python 3.6+
+- Python 3.9+
 
 ## Installation
 
@@ -25,6 +25,18 @@ Install the library via pip:
 pip install caltechdata_api
 ```
 
+Or add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```shell
+uv add caltechdata_api
+```
+
+You can also run a script using uv:
+
+```shell
+uv run write.py
+```
+
 ## Examples
 
 There are some example python scripts in the GitHub repository.
@@ -32,7 +44,7 @@ There are some example python scripts in the GitHub repository.
 ### Create a record:
 
 ```shell
-python write.py example.json -fnames logo.gif
+uv run write.py example.json -fnames logo.gif
 # Output: pbkn6-m9y63 (unique identifier)
 ```
 > The response will be the unique identifier for the record. You can put this at
@@ -42,7 +54,7 @@ https://data.caltechlibrary.dev/records/pbkn6-m9y63)
 ### Edit a record 
 Make changes to the example.json file to see a change)
 ```
-python edit.py example.json -id pbkn6-m9y63
+uv run edit.py example.json -id pbkn6-m9y63
 10.33569/pbkn6-m9y63
 ```
 > The response is the DOI for the record, which includes the unique identifier
@@ -53,13 +65,13 @@ Some groups have worked with the library to create custom DOIs. These can be
 passed in the metadata like:
 
 ```shell
-python write.py example_custom.json -fnames logo.gif
+uv run write.py example_custom.json -fnames logo.gif
 m6zxz-p4j22
 ```
 
 And then you can edit with
 ```
-python edit.py example_custom.json -id m6zxz-p4j22
+uv run edit.py example_custom.json -id m6zxz-p4j22
 10.5281/inveniordm.1234
 ```
 

{caltechdata_api-2.0.0 → caltechdata_api-2.1.0}/caltechdata_api.egg-info/PKG-INFO

@@ -1,20 +1,25 @@
 Metadata-Version: 2.4
 Name: caltechdata_api
-Version: 2.0.0
+Version: 2.1.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
-Classifier: License :: OSI Approved :: MIT License
+Author: Rohan Bhattarai, Elizabeth Won
+Author-email: Thomas E Morrell <tmorrell@caltech.edu>, Alexander A Abakah <aabakah@caltech.edu>, Kshemaahna Nagi <knagi@caltech.edu>
+Maintainer-email: Thomas E Morrell <tmorrell@caltech.edu>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/caltechlibrary/caltechdata_api
+Project-URL: Repository, https://github.com/caltechlibrary/caltechdata_api
+Project-URL: Issues, https://github.com/caltechlibrary/caltechdata_api/issues
+Keywords: metadata,software,InvenioRDM
 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 :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6.0
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -44,7 +49,7 @@ The `caltechdata_api` Python library provides a convenient interface for interac
 
 ## Requirements
 
-- Python 3.6+
+- Python 3.9+
 
 ## Installation
 
@@ -54,6 +59,18 @@ Install the library via pip:
 pip install caltechdata_api
 ```
 
+Or add it to a [uv](https://docs.astral.sh/uv/) project:
+
+```shell
+uv add caltechdata_api
+```
+
+You can also run a script using uv:
+
+```shell
+uv run write.py
+```
+
 ## Examples
 
 There are some example python scripts in the GitHub repository.
@@ -61,7 +78,7 @@ There are some example python scripts in the GitHub repository.
 ### Create a record:
 
 ```shell
-python write.py example.json -fnames logo.gif
+uv run write.py example.json -fnames logo.gif
 # Output: pbkn6-m9y63 (unique identifier)
 ```
 > The response will be the unique identifier for the record. You can put this at
@@ -71,7 +88,7 @@ https://data.caltechlibrary.dev/records/pbkn6-m9y63)
 ### Edit a record 
 Make changes to the example.json file to see a change)
 ```
-python edit.py example.json -id pbkn6-m9y63
+uv run edit.py example.json -id pbkn6-m9y63
 10.33569/pbkn6-m9y63
 ```
 > The response is the DOI for the record, which includes the unique identifier
@@ -82,13 +99,13 @@ Some groups have worked with the library to create custom DOIs. These can be
 passed in the metadata like:
 
 ```shell
-python write.py example_custom.json -fnames logo.gif
+uv run write.py example_custom.json -fnames logo.gif
 m6zxz-p4j22
 ```
 
 And then you can edit with
 ```
-python edit.py example_custom.json -id m6zxz-p4j22
+uv run edit.py example_custom.json -id m6zxz-p4j22
 10.5281/inveniordm.1234
 ```
 

{caltechdata_api-2.0.0 → caltechdata_api-2.1.0}/caltechdata_api.egg-info/SOURCES.txt

@@ -1,8 +1,6 @@
 LICENSE
 README.md
 pyproject.toml
-setup.cfg
-setup.py
 caltechdata_api/__init__.py
 caltechdata_api/caltechdata_edit.py
 caltechdata_api/caltechdata_write.py

caltechdata_api-2.1.0/pyproject.toml

@@ -0,0 +1,69 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "caltechdata_api"
+version = "2.1.0"
+description = "Python wrapper for CaltechDATA API."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+authors = [
+    {name = "Thomas E Morrell", email = "tmorrell@caltech.edu"},
+    {name = "Rohan Bhattarai"},
+    {name = "Elizabeth Won"},
+    {name = "Alexander A Abakah", email = "aabakah@caltech.edu"},
+    {name = "Kshemaahna Nagi", email = "knagi@caltech.edu"},
+]
+maintainers = [
+    {name = "Thomas E Morrell", email = "tmorrell@caltech.edu"},
+]
+keywords = ["metadata", "software", "InvenioRDM"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests",
+    "datacite>1.1.0",
+    "tqdm>=4.62.3",
+    "pyyaml",
+    "s3fs",
+    "cryptography",
+    "s3cmd",
+    "jsonschema-specifications",
+]
+
+[project.urls]
+Homepage = "https://github.com/caltechlibrary/caltechdata_api"
+Repository = "https://github.com/caltechlibrary/caltechdata_api"
+Issues = "https://github.com/caltechlibrary/caltechdata_api/issues"
+
+[project.scripts]
+caltechdata_api = "caltechdata_api.cli:main"
+
+[dependency-groups]
+dev = [
+    "pytest>=7.0",
+    "black",
+]
+
+[tool.setuptools.packages.find]
+include = ["caltechdata_api*"]
+
+[tool.setuptools.package-data]
+caltechdata_api = ["vocabularies.yaml", "vocabularies/*"]
+
+[tool.pytest.ini_options]
+addopts = "--verbose"
+testpaths = ["tests"]
+pythonpath = ["tests"]

caltechdata_api-2.1.0/setup.cfg

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

{caltechdata_api-2.0.0 → caltechdata_api-2.1.0}/tests/test_rdm.py

@@ -7,6 +7,10 @@ from caltechdata_api import (
 import json
 import os
 
+# Any file will do here, we just need something to attach to the test records
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+UPLOAD_FILE = os.path.join(BASE_DIR, "helpers.py")
+
 
 def test_datacite_rdm_conversion(full_datacite43_record, full_rdm_record):
 
@@ -48,7 +52,7 @@ def test_datacite_rdm_create_edit(full_datacite43_record):
         full_datacite43_record,
         schema="43",
         production=False,
-        files=["helpers.py"],
+        files=[UPLOAD_FILE],
         publish=True,
         token=env_token,
     )
@@ -77,7 +81,7 @@ def test_datacite_rdm_create_edit(full_datacite43_record):
     new_doi = caltechdata_edit(
         recid,
         full_datacite43_record,
-        files=["helpers.py"],
+        files=[UPLOAD_FILE],
         schema="43",
         production=False,
         publish=True,

caltechdata_api-2.1.0/tests/test_unit.py

@@ -0,0 +1,76 @@
+import os
+import pytest
+import logging
+from caltechdata_api import validate_metadata as validator43
+from helpers import load_json_path
+
+# Configure logging
+logging.basicConfig(level=logging.DEBUG)
+logger = logging.getLogger(__name__)
+
+# Dynamically determine the base path
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+INVALID_DATACITE43_DIR = os.path.join(BASE_DIR, "data", "invalid_datacite43")
+
+
+# Function to get all JSON files in the directory
+def get_all_json_files(directory):
+    return [
+        os.path.join(directory, f) for f in os.listdir(directory) if f.endswith(".json")
+    ]
+
+
+# Get list of all valid and invalid JSON files
+VALID_DATACITE43_FILES = get_all_json_files(
+    os.path.join(BASE_DIR, "data", "datacite43")
+)
+INVALID_DATACITE43_FILES = get_all_json_files(INVALID_DATACITE43_DIR)
+
+
+@pytest.mark.parametrize("valid_file", VALID_DATACITE43_FILES)
+def test_valid_json(valid_file):
+    """Test that valid example files validate successfully."""
+    print(f"\nValidating file: {valid_file}")
+    json_data = load_json_path(valid_file)
+    validation_errors = None
+    try:
+        validation_errors = validator43(json_data)
+    except ValueError as e:
+        pytest.fail(f"Validation failed for: {valid_file}\nErrors: {str(e)}")
+
+    assert (
+        not validation_errors
+    ), f"Validation failed for: {valid_file}\nErrors: {validation_errors}"
+    print(f"Validation passed for: {valid_file}")
+
+
+@pytest.mark.parametrize("invalid_file", INVALID_DATACITE43_FILES)
+def test_invalid_json(invalid_file):
+    """Test that invalid example files do not validate successfully."""
+    logger.debug(f"Attempting to validate invalid file: {invalid_file}")
+
+    json_data = load_json_path(invalid_file)
+
+    def validate_wrapper():
+        try:
+            validation_errors = validator43(json_data)
+
+            logger.debug(f"Validation result for {invalid_file}: {validation_errors}")
+
+            if validation_errors:
+                logger.debug(f"Found validation errors in {invalid_file}")
+                return
+
+            logger.error(
+                f"No validation errors found for supposedly invalid file: {invalid_file}"
+            )
+            raise ValueError(
+                f"Validation did not fail for invalid file: {invalid_file}"
+            )
+
+        except Exception as e:
+            logger.error(f"Validation exception for {invalid_file}: {str(e)}")
+            raise
+
+    with pytest.raises((ValueError, KeyError, AssertionError, TypeError)):
+        validate_wrapper()

caltechdata_api-2.0.0/pyproject.toml

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

caltechdata_api-2.0.0/setup.cfg

@@ -1,55 +0,0 @@
-[build-system]
-requires = ["setuptools>=64.0","wheel"]
-build-backend = "setuptools.build_meta"
-
-[metadata]
-name = caltechdata_api
-version = 2.0.0
-author = Thomas E Morrell, Rohan Bhattarai, Elizabeth Won, Alexander A Abakah, Kshemaahna Nagi
-author_email = tmorrell@caltech.edu, aabakah@caltech.edu, knagi@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
-	jsonschema-specifications
-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-2.0.0/setup.py

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

caltechdata_api-2.0.0/tests/test_unit.py

@@ -1,166 +0,0 @@
-import os
-import pytest
-import logging
-from caltechdata_api import validate_metadata as validator43
-from helpers import load_json_path
-
-# Configure logging
-logging.basicConfig(level=logging.DEBUG)
-logger = logging.getLogger(__name__)
-
-# Dynamically determine the base path
-BASE_DIR = os.path.dirname(os.path.abspath(__file__))
-INVALID_DATACITE43_DIR = os.path.join(BASE_DIR, "data", "invalid_datacite43")
-DATACITE43_DIR = os.path.join(BASE_DIR, "data")
-
-
-# Function to get all JSON files in the directory
-def get_all_json_files(directory):
-    return [
-        os.path.join(directory, f) for f in os.listdir(directory) if f.endswith(".json")
-    ]
-
-
-# Get list of all valid and invalid JSON files
-VALID_DATACITE43_FILES = get_all_json_files(
-    os.path.join(BASE_DIR, "data", "datacite43")
-)
-INVALID_DATACITE43_FILES = get_all_json_files(INVALID_DATACITE43_DIR)
-
-
-@pytest.mark.parametrize("valid_file", VALID_DATACITE43_FILES)
-def test_valid_json(valid_file):
-    """Test that valid example files validate successfully."""
-    print(f"\nValidating file: {valid_file}")
-    json_data = load_json_path(valid_file)
-    validation_errors = None
-    try:
-        validation_errors = validator43(json_data)
-    except ValueError as e:
-        pytest.fail(f"Validation failed for: {valid_file}\nErrors: {str(e)}")
-
-    assert (
-        not validation_errors
-    ), f"Validation failed for: {valid_file}\nErrors: {validation_errors}"
-    print(f"Validation passed for: {valid_file}")
-
-
-@pytest.mark.parametrize("invalid_file", INVALID_DATACITE43_FILES)
-def test_invalid_json(invalid_file):
-    """Test that invalid example files do not validate successfully."""
-    logger.debug(f"Attempting to validate invalid file: {invalid_file}")
-
-    json_data = load_json_path(invalid_file)
-
-    def validate_wrapper():
-        try:
-            validation_errors = validator43(json_data)
-
-            logger.debug(f"Validation result for {invalid_file}: {validation_errors}")
-
-            if validation_errors:
-                logger.debug(f"Found validation errors in {invalid_file}")
-                return
-
-            logger.error(
-                f"No validation errors found for supposedly invalid file: {invalid_file}"
-            )
-            raise ValueError(
-                f"Validation did not fail for invalid file: {invalid_file}"
-            )
-
-        except Exception as e:
-            logger.error(f"Validation exception for {invalid_file}: {str(e)}")
-            raise
-
-    with pytest.raises((ValueError, KeyError, AssertionError, TypeError)):
-        validate_wrapper()
-
-
-@pytest.mark.parametrize(
-    "missing_field_file",
-    [
-        {
-            "file": os.path.join(DATACITE43_DIR, "missing_creators.json"),
-            "missing_field": "creators",
-        },
-        {
-            "file": os.path.join(DATACITE43_DIR, "missing_titles.json"),
-            "missing_field": "titles",
-        },
-    ],
-)
-def test_missing_required_fields(missing_field_file):
-    """Test that JSON files missing required fields fail validation."""
-    print(
-        f"\nTesting missing field: {missing_field_file['missing_field']} in file: {missing_field_file['file']}"
-    )
-
-    # Skip the test if the file doesn't exist
-    if not os.path.exists(missing_field_file["file"]):
-        pytest.skip(f"Test file not found: {missing_field_file['file']}")
-
-    json_data = load_json_path(missing_field_file["file"])
-    with pytest.raises(
-        ValueError,
-        match=f"Missing required metadata field: {missing_field_file['missing_field']}",
-    ):
-        validator43(json_data)
-
-
-@pytest.mark.parametrize(
-    "type_error_file",
-    [
-        {
-            "file": os.path.join(DATACITE43_DIR, "type_error_creators.json"),
-            "field": "creators",
-        },
-        {
-            "file": os.path.join(DATACITE43_DIR, "type_error_dates.json"),
-            "field": "dates",
-        },
-    ],
-)
-def test_incorrect_field_types(type_error_file):
-    """Test that JSON files with incorrect field types fail validation."""
-    print(
-        f"\nTesting incorrect type in field: {type_error_file['field']} for file: {type_error_file['file']}"
-    )
-
-    # Skip the test if the file doesn't exist
-    if not os.path.exists(type_error_file["file"]):
-        pytest.skip(f"Test file not found: {type_error_file['file']}")
-
-    json_data = load_json_path(type_error_file["file"])
-    with pytest.raises(
-        ValueError, match=f"Incorrect type for field: {type_error_file['field']}"
-    ):
-        validator43(json_data)
-
-
-def test_multiple_errors():
-    """Test JSON file with multiple issues to check all errors are raised."""
-    multiple_errors_file = os.path.join(DATACITE43_DIR, "multiple_errors.json")
-
-    # Skip the test if the file doesn't exist
-    if not os.path.exists(multiple_errors_file):
-        pytest.skip(f"Test file not found: {multiple_errors_file}")
-
-    json_data = load_json_path(multiple_errors_file)
-    with pytest.raises(ValueError, match="Multiple validation errors"):
-        validator43(json_data)
-
-
-def test_error_logging(caplog):
-    """Test that errors are logged correctly during validation."""
-    some_invalid_file = os.path.join(INVALID_DATACITE43_DIR, "some_invalid_file.json")
-
-    # Skip the test if the file doesn't exist
-    if not os.path.exists(some_invalid_file):
-        pytest.skip(f"Test file not found: {some_invalid_file}")
-
-    json_data = load_json_path(some_invalid_file)
-    with caplog.at_level(logging.ERROR):
-        with pytest.raises(ValueError):
-            validator43(json_data)
-    assert "Validation failed" in caplog.text