Integrate model and api module with each other

[skasberger]

Integrate the pyDataverse models with the API calls.

The idea is, that the usage of the api and the models module is as conventient and easy as possible.

Inspired by #9.

Prepare

• [ ] Design, how this is done best
  • [ ] Idea: Create a model class for the dataverse tree.
  • [ ] Idea: Create a model class for a user
  • [ ] Idea: Create a model class for a role
  • [ ] Idea: Return pyDataverse model objects from API requests
  • [ ] Idea: attach pyDataverse models to an pyDataverse model. e.g. attach a list of Dataverses and Datasets to a Dataverse object. Create the tree structure by this.,
  • [ ] Keep the normal usage in mind. Think of possible interactions between api and models. Think through each use-case: data migration, deployment, testing, microservice, data science
  • [ ] Question: Should there be saved the state of the data and metadata? Could this be trusted?
  • [ ] Define the scope and purpose of each module alone but also in for integrated usage.
  • [ ] Draw a flow diagram

Implementation

• [ ] Write tests
• [ ] Update code
• [ ] Update Docs
• [ ] Update Docstrings
• [ ] Run pytest
• [ ] Run tox
• [ ] Run pylint
• [ ] Run mypy

Review

• [ ] Code
• [ ] Tests
• [ ] Docs

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