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 #82
• [ ] Test Strategy #70
• [ ] Test data #84
• [ ] Review API module #71
• [ ] Implement Test Strategy #83
  • [ ] Write Smoke Tests #87
• [ ] Merge API classes #123
• [ ] Check identifier requests usage #17
• [ ] Return additional data-types from requests #9
• [ ] PR: Upload file object #62
• [ ] Bug: get_request() params overwritten #85
• [ ] Remove auth #76
• [ ] API waiting time #75
• [ ] Collect API responses #17

Logging

• [ ] Logging #44

Other API enhancements

• [ ] Add file-type to upload #118
• [ ] Add "storageDriveLevel" to create dataverse #119
• [ ] Verify file integrity by hash sum #115
• [ ] Bug: Delete Roles via API not working #112
• [ ] Remove curl dependency #88
• [ ] Remove trailing slash #73
• [ ] User-Agent #99
• [ ] Download Draft Datasets #42
• [ ] Bug: Encoding: #55
• [ ] Bug: API group creation fails #86
• [ ] Bug: get_user() #77

Re-factor get_children()

Utils

• [ ] Bug: write_json empty lists #95
• [ ] write_dict_as_csv fieldnames #96
• [ ] Test CSV templates #93

Code Style

• [ ] f-Strings #90
• [ ] Linting #92
• [ ] Type Annotations #91
• [ ] kwargs & args #72
• [ ] Update API docstrings #89
  • [ ] Parameter 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