changes to add new version to exisitng deposition #4

drifter089 · 2024-11-12T09:19:01Z

set_project can now also be update parent DOI
- it returns the latest draft or published version if given parent DOI
- function now gives automatically resolves to latest 113600 ID for 106299
new ZenodoMetaData dataclass
updated change_metadata function using new ZenodoMetadata class
ZenodoMetadata class can be extended to include these properties Zenodo docs metadata
update function adds publication_date to metadata if empty which is required to publish a new version
all internal functions are being tested
version update is being tested in test_vesion.py using CI
individual tests for create_project, set_project, change_metadata are still missing even tough they are being tested together in CI

drifter089 · 2024-11-21T08:46:19Z

update and create_project functions look like this

siddharth-krishna

Thanks Akshat, it looks good overall, but I left a few suggestions. Can we also change the PR title to cover all the changes: disable old tests, refactor XYZ, add new test etc?

requirements.txt

siddharth-krishna · 2024-11-21T12:11:08Z

src/zenodopy/zenodopy.py

@@ -351,7 +362,9 @@ def list_files(self):
            # except UserWarning:
            # warnings.warn("The object is not pointing to a project. Either create a project or explicity set the project'", UserWarning)

-    def create_project(self, title=None, upload_type=None, description=None):
+    def create_project(
+        self, title=None, upload_type=None, metadata_json=None, description=None


upload_type is unused?

src/zenodopy/zenodopy.py

siddharth-krishna · 2024-11-21T12:15:25Z

tests/test_zenodopy.py

-    zeno.bucket
-    zeno.deposition_id
-    zeno.sandbox
+# def test_get_key():


Would be good to put a comment above each disabled test saying why it no longer works and when it can be brought back

added a note at the start of the file

src/zenodopy/zenodopy.py

drifter089 · 2024-11-28T07:50:44Z

tests/test_zenodopy.py

+"""
+This module contains tests for the zenodopy library using pytest.
+Functions:
+    test_client: Tests the initialization of the zen.Client object with and without a token.
+    test_read_config: Tests the _read_config method of the zen.Client object to ensure it raises a TypeError.
+    test_get_baseurl: Tests the _endpoint attribute of the zen.Client object for both sandbox and production environments.
+    test_get_depositions: Tests the _get_depositions, _get_depositions_by_id, and _get_depositions_files methods of the zen.Client object.
+    test_get_bucket: Tests the _get_bucket_by_id method of the zen.Client object.
+    test_get_projects_and_files: Tests the list_projects and list_files properties of the zen.Client object.
+Note:
+    The update and change_metadata functions have been updated to add new versions to existing depositions. 
+    This functionality is being tested in test_version. We will bring back individual tests once these changes 
+    have been merged upstream to keep the changes incremental.
+"""


@siddharth-krishna
does this comment convey the plan clearly ?
I can update it to be more clear

It does, but I still feel each individual line is better placed as a docstring/comment for the appropriate test function. Also, that way someone who jumps to the middle of the file will see why something is disabled, or what a function is testing. But this isn't critical, can be done later too.

siddharth-krishna

Thanks Akshat, it looks good overall. A few suggestions:

When you make the upstream PR, include in the description things like: why we disabled some tests, why we deleted coverage.yaml, why we disabled tests for older python versions, why replaced tox with pytest, and of course why we had to change the way version updates work.

tests/test_version.py

siddharth-krishna · 2024-12-02T13:55:55Z

tests/test_zenodopy.py

+"""
+This module contains tests for the zenodopy library using pytest.
+Functions:
+    test_client: Tests the initialization of the zen.Client object with and without a token.
+    test_read_config: Tests the _read_config method of the zen.Client object to ensure it raises a TypeError.
+    test_get_baseurl: Tests the _endpoint attribute of the zen.Client object for both sandbox and production environments.
+    test_get_depositions: Tests the _get_depositions, _get_depositions_by_id, and _get_depositions_files methods of the zen.Client object.
+    test_get_bucket: Tests the _get_bucket_by_id method of the zen.Client object.
+    test_get_projects_and_files: Tests the list_projects and list_files properties of the zen.Client object.
+Note:
+    The update and change_metadata functions have been updated to add new versions to existing depositions. 
+    This functionality is being tested in test_version. We will bring back individual tests once these changes 
+    have been merged upstream to keep the changes incremental.
+"""


It does, but I still feel each individual line is better placed as a docstring/comment for the appropriate test function. Also, that way someone who jumps to the middle of the file will see why something is disabled, or what a function is testing. But this isn't critical, can be done later too.

drifter089 · 2024-12-04T09:28:24Z

I will bring back individual tests in next PR and add coverage and other things it causes CI to fail so only testing with pytest,
learning about TOX more

remove title from create_project

drifter089 added 6 commits October 24, 2024 15:20

adding latest python setup version

37fb3cd

adding latest python version

a3123a0

testing with only local version

715ea0c

adding new CI

0c1fb5e

using new PR brnach

8e40ec6

disabled previous tests added basic test

bb5c86b

drifter089 requested a review from siddharth-krishna November 21, 2024 08:52

siddharth-krishna reviewed Nov 21, 2024

View reviewed changes

drifter089 added 3 commits November 28, 2024 14:15

test using this branch

5f842b8

update get_deposition_by_id

222d77e

adding comment to tests

e791404

drifter089 commented Nov 28, 2024

View reviewed changes

drifter089 added 6 commits November 28, 2024 14:57

remove datetime

9730e1e

remove unused args from create_project function

1400164

try new zenodo metadat class

67fcd0e

using new ZenodoMeteDataClass

ca75a86

using new metadata argument

cd689da

use same branch

1f8aa61

drifter089 requested a review from siddharth-krishna November 28, 2024 10:44

removing commented code

65eef94

drifter089 changed the title ~~Basic test~~ chnages to add new version to exisitng deposition Nov 28, 2024

drifter089 changed the title ~~chnages to add new version to exisitng deposition~~ changes to add new version to exisitng deposition Nov 30, 2024

siddharth-krishna approved these changes Dec 2, 2024

View reviewed changes

add json file parse logic as data class function

b10ed9c

drifter089 mentioned this pull request Dec 5, 2024

changes to add new version to exisitng deposition lgloege/zenodopy#20

Open

Update zenodopy.py

909f439

remove title from create_project

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

changes to add new version to exisitng deposition #4

changes to add new version to exisitng deposition #4

drifter089 commented Nov 12, 2024 •

edited

Loading

drifter089 commented Nov 21, 2024

siddharth-krishna left a comment

siddharth-krishna Nov 21, 2024

siddharth-krishna Nov 21, 2024

drifter089 Nov 28, 2024

drifter089 Nov 28, 2024

siddharth-krishna Dec 2, 2024

siddharth-krishna left a comment

siddharth-krishna Dec 2, 2024

drifter089 commented Dec 4, 2024

changes to add new version to exisitng deposition #4

Are you sure you want to change the base?

changes to add new version to exisitng deposition #4

Conversation

drifter089 commented Nov 12, 2024 • edited Loading

drifter089 commented Nov 21, 2024

siddharth-krishna left a comment

Choose a reason for hiding this comment

siddharth-krishna Nov 21, 2024

Choose a reason for hiding this comment

siddharth-krishna Nov 21, 2024

Choose a reason for hiding this comment

drifter089 Nov 28, 2024

Choose a reason for hiding this comment

drifter089 Nov 28, 2024

Choose a reason for hiding this comment

siddharth-krishna Dec 2, 2024

Choose a reason for hiding this comment

siddharth-krishna left a comment

Choose a reason for hiding this comment

siddharth-krishna Dec 2, 2024

Choose a reason for hiding this comment

drifter089 commented Dec 4, 2024

drifter089 commented Nov 12, 2024 •

edited

Loading