As discussed in the last pyWG Meeting and in parallel to the 0.4.0update, the intermediate docs are now hosted for inspection:
https://pydataverse.vercel.app/getting-started
There are still some open points to be changed and added, but the current form reflects most of the new/old features. Specifically missing or needing update are the MCP and FS docs. These will be updated in the upcoming week.
Feedback is much appreciated! As a disclaimer, I have used GPT and Grammarly to rephrase parts of the docs.
Fantastic! :tada: If I want to suggest a change, where is the source?
This is the current branch:
https://github.com/gdcc/pyDataverse/tree/refactor-api
Now that https://github.com/gdcc/pyDataverse/pull/227 has been merged, the docs are live at https://gdcc.github.io/pyDataverse/getting-started/ , right?
Yes, and they are synced to the main branch
Currently looking into versioning with astro
Nice. I just made https://github.com/gdcc/pyDataverse/pull/231 to update the README to link to the new docs but I'm not sure if the timing is right. :sweat_smile:
Ah nice, thanks for catching that! Just merged
Thanks!
At https://pypi.org/project/pyDataverse/ the link to the docs will be updated when we make a release, right?
Yes, the Readme will be mirrored. I have also added the documentation URL to the pyproject.toml, which will then also link to the docs at PyPI
From https://gdcc.github.io/pyDataverse/getting-started/#example-code
# 2. Select a collection and a dataset
collection = dv.collections["my-collection"]
dataset = collection.datasets["doi:10.5072/FK2/ABC123"]
Is it required to specify the collection? The Dataverse API shouldn't care which collection the dataset is in, I would think.
No, the following would also work:
dv.datasets["doi:..."]
Ok, cool. Could be an opportunity to simply.
Last updated: Aug 18 2026 at 08:27 UTC