Skip to content

bump from pyDataverse 0.2.1 to 0.3.5, cleanup #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pdurbin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

bump from pyDataverse 0.2.1 to 0.3.5, cleanup #46

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cd05b8
bump from pyDataverse 0.2.1 to 0.3.5, cleanup
pdurbin Oct 30, 2025
d523e26
print /api/info/version #43
pdurbin Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions create_sample_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from pyDataverse.api import Api
from pyDataverse.api import NativeApi
from pyDataverse.models import Datafile
import json
import dvconfig
import os
Expand All @@ -13,18 +14,16 @@
except:
print("Using API token from config file.")
paths = dvconfig.sample_data
api = Api(base_url, api_token)
print(api.status)
api = NativeApi(base_url, api_token)
print(api.get_info_version())
Copy link
Copy Markdown
Member Author

@pdurbin pdurbin Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem to print anything. 🤷

Copy link
Copy Markdown

@JR-1991 JR-1991 Nov 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pdurbin you need to invoke .json() to receive the content of the response. The object returned by any method of the current pyDataverse version returns a raw Response object, which needs to be handled. Here is a Colab for demo:

https://colab.research.google.com/drive/1g61CEb5yVr3IhwD3hTKftgTbd6II4y01?usp=sharing

Copy link
Copy Markdown
Member Author

@pdurbin pdurbin Nov 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JR-1991 thanks! Fixed in d523e26.

# TODO limit amount of recursion
def check_dataset_lock(dataset_dbid):
query_str = '/datasets/' + str(dataset_dbid) + '/locks'
params = {}
resp = api.get_request(query_str, params=params, auth=True)
def check_dataset_lock(dataset_pid):
resp = api.get_dataset_lock(dataset_pid)
locks = resp.json()['data']
if (locks):
print('Lock found for dataset id ' + str(dataset_dbid) + '... sleeping...')
print('Lock found for dataset id ' + str(dataset_pid) + '... sleeping...')
time.sleep(2)
check_dataset_lock(dataset_dbid)
check_dataset_lock(dataset_pid)
resp = api.get_dataverse(':root')
buff = StringIO("")
if (resp.status_code == 401):
Expand All @@ -48,9 +47,8 @@ def check_dataset_lock(dataset_dbid):
with open(dv_json) as f:
metadata = json.load(f)
print(metadata)
# FIXME: Why is "identifier" required?
identifier = metadata['alias']
resp = api.create_dataverse(identifier, json.dumps(metadata), parent=parent)
resp = api.create_dataverse(parent, json.dumps(metadata))
print(resp)
resp = api.publish_dataverse(identifier)
print(resp)
Expand All @@ -73,12 +71,15 @@ def check_dataset_lock(dataset_dbid):
relpath = os.path.relpath(filepath,files_dir)
# "directoryLabel" is used to populate "File Path"
directoryLabel, filename = os.path.split(relpath)
resp = api.upload_file(dataset_pid, "'" + filepath + "'")
df = Datafile()
df_filename = filepath
df.set({"pid": dataset_pid, "filename": df_filename})
resp = api.upload_datafile(dataset_pid, df_filename, df.json())
print(resp)
file_id = resp['data']['files'][0]['dataFile']['id']
file_id = resp.json()['data']['files'][0]['dataFile']['id']
## This lock check and sleep is here to prevent the dataset from being permanently
## locked because a tabular file was uploaded first.
check_dataset_lock(dataset_dbid)
check_dataset_lock(dataset_pid)
# TODO: Think more about where the description comes from. A "sidecar" file as proposed at https://github.com/IQSS/dataverse/issues/5924#issuecomment-499605672 ?
# L.A.: I implemented something along these lines - an (optional) directory called ".filemetadata"
# in the dataset directory, where files containing extra json filemetadata records may be
Expand Down
11 changes: 4 additions & 7 deletions destroy_all_dvobjects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
from pyDataverse.api import Api
import json
from pyDataverse.api import NativeApi
import dvconfig
import requests
import os
Expand All @@ -10,8 +9,8 @@
print("Using API token from $API_TOKEN.")
except:
print("Using API token from config file.")
api = Api(base_url, api_token)
print('API status: ' +api.status)
api = NativeApi(base_url, api_token)
print(api.get_info_version())

dataverse_ids = []
dataset_ids = []
Expand All @@ -35,9 +34,7 @@ def main():
print("Done.")

def find_children(dataverse_database_id):
query_str = '/dataverses/' + str(dataverse_database_id) + '/contents'
params = {}
resp = api.get_request(query_str, params=params, auth=True)
resp = api.get_dataverse_contents(dataverse_database_id)
for dvobject in resp.json()['data']:
dvtype = dvobject['type']
dvid = dvobject['id']
Expand Down
5 changes: 3 additions & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
pyDataverse==0.2.1
CairoSVG==2.7.1
pyDataverse==0.3.5
CairoSVG==2.7.1
requests==2.32.5