Installation

pyDataverse is a Python library for interacting with Dataverse installations. It provides a high-level interface for creating datasets, managing collections, working with files, and accessing Dataverse APIs.

Requirements

pyDataverse requires Python 3.10 or higher. You can check your Python version by running python --version in your terminal. If you need to install or upgrade Python, visit python.org.

Installation

Create and activate a virtual environment first:

python -m venv .venv
source .venv/bin/activate

Choose one package manager (pip, uv, or poetry) for this environment.

pip

Install from PyPI:

python -m pip install pyDataverse

Install from local source (repository checkout):

python -m pip install .

Install with test dependencies:

python -m pip install ".[tests]"

uv

Install from PyPI:

uv pip install pyDataverse

Install from local source (repository checkout):

uv pip install .

Install with test dependencies:

uv sync --extra tests

poetry

Install runtime dependencies:

poetry install

Install with test dependencies:

poetry install --extras tests

Next Steps

After installation, you’re ready to start using pyDataverse. Here’s what to do next:

• Read the Dataverse documentation to learn how to create datasets and manage collections
• Try connecting to a public Dataverse installation to explore what’s available
• For authenticated operations like creating datasets or uploading files, you’ll need an API token from your Dataverse installation (available in your account settings)

Getting Help

If you encounter issues or have questions:

• Check the documentation for usage examples and API reference
• Report bugs or ask questions on the GitHub repository
• Join the Dataverse Zulip channel for community support

See Also

• Dataverse Documentation - Learn how to use pyDataverse
• Dataset Documentation - Working with datasets
• Collection Documentation - Managing collections
• File Documentation - Working with files