Release Plan 0.4.0

[skasberger]

General

Milestone

Goal

Re-factor API module. Improve Open Source development, testing and community support to a level, so it is easy to build upon.

Features

• Improve project management
  • Risk assessment
  • Create test strategy
  • Open up knowledge
• Create test data
• Re-factor API
  • get_children and related functions

Plan

Re-factor API

• Risk Assessment Create risk assessment #82
• Test Strategy Work out test strategy and test plan #70
• Test data Work out test data after test strategy #84
• Review API module Re-factor API module #71
• Implement Test Strategy Implement test strategy for API tests #83
  • Write Smoke Tests Write smoke tests #87
• Merge API classes Merge API classes #123
• Check identifier requests usage Check all API requests of Datasets for identifier compatibility #17
• Return additional data-types from requests Return a pyDataverse object from an API requests #9
• PR: Upload file object Allows for uploading a file object. #62
• Bug: get_request() params overwritten get_request params get overwritten #85
• Remove auth Authentication by API token, not parameter passing #76
• API waiting time Add API waiting time functionality #75
• Collect API responses Check all API requests of Datasets for identifier compatibility #17

Logging

• Logging Add logging functionality #44

Other API enhancements

• Add file-type to upload Add file-type to file upload #118
• Add "storageDriveLevel" to create dataverse Add "storageDriveLevel" to create dataverse #119
• Verify file integrity by hash sum Verify file integrity of downloaded files by hash sum #115
• Bug: Delete Roles via API not working Delete Roles via API not working #112
• Remove curl dependency Remove curl dependency #88
• Remove trailing slash Remove trailing slash in base_url #73
• User-Agent Improve the handling of the requests User-Agent #99
• Download Draft Datasets Add Dataset draft downloading #42
• Bug: Encoding: Encoding issue using create_dataset() #55
• Bug: API group creation fails create explicit group fails #86
• Bug: get_user() Correct get_user() call #77

Re-factor get_children()

Utils

• Bug: write_json empty lists write_json() does not accept empty lists #95
• write_dict_as_csv fieldnames improve write_dict_as_csv() usage of fieldnames  #96
• Test CSV templates Test CSV templates #93

Code Style

• f-Strings Use f-strings #90
• Linting Use linting #92
• Type Annotations Use type annotations  #91
• kwargs & args Update functions with kwargs & args #72
• Update API docstrings Update API docstrings #89
  • Parameter get_datafile() Parameterize get_datafile #49

[pdurbin]

As discussed during the 2024-02-14 meeting of the pyDataverse working group, we are closing old milestones in favor of a new project board at https://github.com/orgs/gdcc/projects/1 and removing issues (like this one) from those old milestones. Please feel free to join the working group! You can find us at https://py.gdcc.io and https://dataverse.zulipchat.com/#narrow/stream/377090-python