Update functions with kwargs & args

[skasberger]

Update function params to kwargs & args, to make parameter passing more consistent and flexible.

Prepare

• [ ] Check, if this makes sense

Change

• [ ] Develop tests
• [ ] Update functions: Write code, Docstrings, Tests
  • [ ] Api.Api
    • [ ] __init__
    • [ ] __str__
    • [ ] delete_request
    • [ ] get_request
    • [ ] post_request
    • [ ] put_request
  • [ ] NativeApi
    • [ ] __init__
    • [ ] __str__
    • [ ] create_dataset
    • [ ] create_dataset_private_url
    • [ ] create_dataverse
    • [ ] create_role
    • [ ] dataverse_id2alias
    • [ ] delete_dataset
    • [ ] delete_dataset_private_url
    • [ ] delete_dataverse
    • [ ] delete_request
    • [ ] delete_role
    • [ ] delete_user_api_token
    • [ ] destroy_dataset
    • [ ] edit_dataset_metadata
    • [ ] get_children
    • [ ] get_datafile_metadata
    • [ ] get_datafiles_metadata
    • [ ] get_dataset
    • [ ] get_dataset_assignments
    • [ ] get_dataset_export
    • [ ] get_dataset_lock
    • [ ] get_dataset_private_url
    • [ ] get_dataset_version
    • [ ] get_dataset_versions
    • [ ] get_dataverse
    • [ ] get_dataverse_assignments
    • [ ] get_dataverse_contents
    • [ ] get_dataverse_facets
    • [ ] get_dataverse_roles
    • [ ] get_info_api_terms_of_use
    • [ ] get_info_server
    • [ ] get_info_version
    • [ ] get_metadatablock
    • [ ] get_metadatablocks
    • [ ] get_request
    • [ ] get_user
    • [ ] get_user_api_token_expiration_date
    • [ ] post_request
    • [ ] publish_dataset
    • [ ] publish_dataverse
    • [ ] put_request
    • [ ] recreate_user_api_token
    • [ ] redetect_file_type
    • [ ] reingest_datafile
    • [ ] replace_datafile
    • [ ] restrict_datafile
    • [ ] show_role
    • [ ] uningest_datafile
    • [ ] update_datafile_metadata
    • [ ] upload_datafile
  • [ ] MetricsApi
    • [ ] __init__
    • [ ] __str__
    • [ ] delete_request
    • [ ] get_datasets_by_data_location
    • [ ] get_datasets_by_subject
    • [ ] get_dataverses_by_category
    • [ ] get_dataverses_by_subject
    • [ ] get_request
    • [ ] past_days
    • [ ] post_request
    • [ ] put_request
    • [ ] total
  • [ ] SwordApi
    • [ ] __init__
    • [ ] __str__
    • [ ] delete_request
    • [ ] get_request
    • [ ] get_service_document
    • [ ] post_request
    • [ ] put_request
  • [ ] SearchApi
    • [ ] __init__
    • [ ] __str__
    • [ ] delete_request
    • [ ] get_request
    • [ ] post_request
    • [ ] put_request
    • [ ] search
  • [ ] DataAccessApi
    • [ ] __init__
    • [ ] __str__
    • [ ] allow_access_request
    • [ ] delete_request
    • [ ] get_datafile
    • [ ] get_datafile_bundle
    • [ ] get_datafiles
    • [ ] get_request
    • [ ] grant_file_access
    • [ ] list_file_access_requests
    • [ ] post_request
    • [ ] put_request
    • [ ] request_access
  • [ ]DVObject
    • [ ] __init__
    • [ ] from_json
    • [ ] get
    • [ ] json
    • [ ] set
    • [ ] validate_json
  • [ ]Dataverse
    • [ ] __init__
    • [ ] from_json
    • [ ] get
    • [ ] json
    • [ ] set
    • [ ] validate_json
  • [ ]Dataset
    • [ ] _Dataset__generate_field_arrays
    • [ ] _Dataset__parse_field_array
    • [ ] __init__
    • [ ] from_json
    • [ ] get
    • [ ] json
    • [ ] set
    • [ ] validate_json
  • [ ]Datafile
    • [ ] __init__
    • [ ] from_json
    • [ ] get
    • [ ] json
    • [ ] set
    • [ ] validate_json
  • [ ]Utils
    • [ ] clean_string
    • [ ] create_datafile_url
    • [ ] create_dataset_url
    • [ ] create_dataverse_url
    • [ ] dataverse_tree_walker
    • [ ] read_csv
    • [ ] read_csv_as_dicts
    • [ ] read_file
    • [ ] read_json
    • [ ] read_pickle
    • [ ] save_tree_data
    • [ ] validate
    • [ ] validate_data
    • [ ] write_csv
    • [ ] write_dicts_as_csv
    • [ ] write_file
    • [ ] write_json
    • [ ] write_pickle
• [ ] Update Docs

Review

• [ ] Tests
• [ ] Docs
• [ ] Type annotation
• [ ] Linting

Follow-Ups

• [ ]

[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