[](https://pypi.org/project/pyDataverse/) [](https://anaconda.org/conda-forge/pydataverse/)  [](https://coveralls.io/github/gdcc/pyDataverse) [](https://pydataverse.readthedocs.io/en/latest) <img src="https://img.shields.io/badge/python-3.8 | 3.9 | 3.10 | 3.11-blue.svg" alt="PyPI - Python Version"> [](https://opensource.org/licenses/MIT) [](https://github.com/psf/black) [](https://doi.org/10.5281/zenodo.4664557)
# pyDataverse
[](https://www.repostatus.org/#active)
pyDataverse is a Python module for [Dataverse](http://dataverse.org).
It helps to access the Dataverse [API's](http://guides.dataverse.org/en/latest/api/index.html) and manipulate, validate, import and export all Dataverse data-types (Dataverse, Dataset, Datafile).
**Find out more: [Read the Docs](https://pydataverse.readthedocs.io/en/latest/)**
# Running tests
In order to run the tests, you need to have a Dataverse instance running. We have prepared a shell script that will start a Dataverse instance using Docker that runs all tests in a clean environment. To run the tests, execute the following command:
```bash
# Defaults to Python 3.11
./run_tests.sh
# To run the tests with a specific Python version
./run_tests.sh -p 3.8
```
Once finished, you can find the test results in the `dv/unit-tests.log` file and in the terminal.
## Manual setup
If you want to run single tests you need to manually set up the environment and set up the necessary environment variables. Please follow the instructions below.
**1. Start the Dataverse instance**
```bash
docker compose \
-f ./docker/docker-compose-base.yml \
--env-file local-test.env \
up -d
```
**2. Set up the environment variables**
```bash
export BASE_URL=http://localhost:8080
export DV_VERSION=6.2 # or any other version
export $(grep "API_TOKEN" "dv/bootstrap.exposed.env")
export API_TOKEN_SUPERUSER=$API_TOKEN
```
**3. Run the test(s) with pytest**
```bash
python -m pytest -v
```
## Chat with us!
If you are interested in the development of pyDataverse, we invite you to join us for a chat on our [Zulip Channel](https://dataverse.zulipchat.com/#narrow/stream/377090-python). This is the perfect place to discuss and exchange ideas about the development of pyDataverse. Whether you need help or have ideas to share, feel free to join us!
## PyDataverse Working Group
We have formed a [pyDataverse working group](https://py.gdcc.io) to exchange ideas and collaborate on pyDataverse. There is a bi-weekly meeting planned for this purpose, and you are welcome to join us by clicking the following [WebEx meeting link](https://unistuttgart.webex.com/unistuttgart/j.php?MTID=m322473ae7c744792437ce854422e52a3). For a list of all the scheduled dates, please refer to the [Dataverse Community calendar](https://calendar.google.com/calendar/u/1?cid=Y191ZG40dG9ubTQwMWtnampyZTRqbDRqYTBjc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t).
Raw data
{
"_id": null,
"home_page": "https://github.com/gdcc/pyDataverse",
"name": "pyDataverse",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Stefan Kasberger",
"author_email": "stefan.kasberger@univie.ac.at",
"download_url": "https://files.pythonhosted.org/packages/83/88/066d273a2b28644538865266f5e93b2c0c6b97a4be36b544cc93f18f6d60/pydataverse-0.3.3.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/pyDataverse/) [](https://anaconda.org/conda-forge/pydataverse/)  [](https://coveralls.io/github/gdcc/pyDataverse) [](https://pydataverse.readthedocs.io/en/latest) <img src=\"https://img.shields.io/badge/python-3.8 | 3.9 | 3.10 | 3.11-blue.svg\" alt=\"PyPI - Python Version\"> [](https://opensource.org/licenses/MIT) [](https://github.com/psf/black) [](https://doi.org/10.5281/zenodo.4664557)\n\n# pyDataverse\n\n[](https://www.repostatus.org/#active)\n\npyDataverse is a Python module for [Dataverse](http://dataverse.org).\nIt helps to access the Dataverse [API's](http://guides.dataverse.org/en/latest/api/index.html) and manipulate, validate, import and export all Dataverse data-types (Dataverse, Dataset, Datafile).\n\n**Find out more: [Read the Docs](https://pydataverse.readthedocs.io/en/latest/)**\n\n# Running tests\n\nIn order to run the tests, you need to have a Dataverse instance running. We have prepared a shell script that will start a Dataverse instance using Docker that runs all tests in a clean environment. To run the tests, execute the following command:\n\n```bash\n# Defaults to Python 3.11\n./run_tests.sh\n\n# To run the tests with a specific Python version\n./run_tests.sh -p 3.8\n```\n\nOnce finished, you can find the test results in the `dv/unit-tests.log` file and in the terminal.\n\n## Manual setup\n\nIf you want to run single tests you need to manually set up the environment and set up the necessary environment variables. Please follow the instructions below.\n\n**1. Start the Dataverse instance**\n\n```bash\ndocker compose \\\n -f ./docker/docker-compose-base.yml \\\n --env-file local-test.env \\\n up -d\n```\n\n**2. Set up the environment variables**\n\n```bash\nexport BASE_URL=http://localhost:8080\nexport DV_VERSION=6.2 # or any other version\nexport $(grep \"API_TOKEN\" \"dv/bootstrap.exposed.env\")\nexport API_TOKEN_SUPERUSER=$API_TOKEN\n```\n\n**3. Run the test(s) with pytest**\n\n```bash\npython -m pytest -v\n```\n\n## Chat with us!\n\nIf you are interested in the development of pyDataverse, we invite you to join us for a chat on our [Zulip Channel](https://dataverse.zulipchat.com/#narrow/stream/377090-python). This is the perfect place to discuss and exchange ideas about the development of pyDataverse. Whether you need help or have ideas to share, feel free to join us!\n\n## PyDataverse Working Group\n\nWe have formed a [pyDataverse working group](https://py.gdcc.io) to exchange ideas and collaborate on pyDataverse. There is a bi-weekly meeting planned for this purpose, and you are welcome to join us by clicking the following [WebEx meeting link](https://unistuttgart.webex.com/unistuttgart/j.php?MTID=m322473ae7c744792437ce854422e52a3). For a list of all the scheduled dates, please refer to the [Dataverse Community calendar](https://calendar.google.com/calendar/u/1?cid=Y191ZG40dG9ubTQwMWtnampyZTRqbDRqYTBjc0Bncm91cC5jYWxlbmRhci5nb29nbGUuY29t).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python module for Dataverse.",
"version": "0.3.3",
"project_urls": {
"Homepage": "https://github.com/gdcc/pyDataverse",
"Repository": "https://github.com/gdcc/pyDataverse"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b3866c22a98a1daf4e847a151bbc967c4ed55bea08497e1d255f3f5b4d22c4d",
"md5": "d7a2f9f0c0fbb1313c51b5bae8f064ff",
"sha256": "181a4768bb37e3b8261f78245a6ac42399c87c0cba89b4638afc5bb1a5a692f8"
},
"downloads": -1,
"filename": "pydataverse-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7a2f9f0c0fbb1313c51b5bae8f064ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.1",
"size": 93113,
"upload_time": "2024-05-23T06:17:09",
"upload_time_iso_8601": "2024-05-23T06:17:09.647712Z",
"url": "https://files.pythonhosted.org/packages/2b/38/66c22a98a1daf4e847a151bbc967c4ed55bea08497e1d255f3f5b4d22c4d/pydataverse-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8388066d273a2b28644538865266f5e93b2c0c6b97a4be36b544cc93f18f6d60",
"md5": "fa5e4c089db83c08a3717319af4b90a7",
"sha256": "d5f959735a70d2f955aa354da29f2f851406dffae915f31277cd01ae2b030c99"
},
"downloads": -1,
"filename": "pydataverse-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "fa5e4c089db83c08a3717319af4b90a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.1",
"size": 85522,
"upload_time": "2024-05-23T06:17:11",
"upload_time_iso_8601": "2024-05-23T06:17:11.521449Z",
"url": "https://files.pythonhosted.org/packages/83/88/066d273a2b28644538865266f5e93b2c0c6b97a4be36b544cc93f18f6d60/pydataverse-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-23 06:17:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gdcc",
"github_project": "pyDataverse",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "httpx",
"specs": [
[
"==",
"0.27.0"
]
]
},
{
"name": "jsonschema",
"specs": [
[
"==",
"4.21.1"
]
]
}
],
"tox": true,
"lcname": "pydataverse"
}
JSON
