OpenEnergyPlatform
Deprecate features from open-mastr
Discussion
Users that are affected by this deprecation can leave their comments in this issue.
Should we think about adding a deprecation warning to the soap API features .download and .mirror? We could print the message that those features will not be maintained in the future. If people still use them, they should tell us in an Issue.
Explanation
Both functions are used to download large amount of data via the SOAP API. Since BNetzA has a bulk download for quite some time now, I don't think that we need to maintain this feature anymore.
@chrwm What do you think?
Todos
- [ ] State very prominently in documentation that these features are deprecated, maybe even in the sidebar
- [x] Delete tests for the deprecated features
Currently mastr mirror tests are causing problems, so we should also delete those tests and rather focus our (limited) time on fixing and maintaining other parts of the code.
The data that can be downloaded with the BULK download from the open zip file is different from the data a user can download over the API download. For example a "Netzbetreiber" can get the geo coordinates of all units connected to his grid. I don't see a solution for this problem or do I miss something?
Hi @hochwasser, we will not deprecate the SOAP API wrapper. There are three classes in open-mastr: MaStRAPI, MaStRDownload, and MaStRMirror. We plan to deprecate Download and Mirror - but keep the API Wrapper from MaStRAPI. With the MaStRAPI class it will still be possible to call all methods that are described on the website of BNetzA.
Are you using the Download and Mirror classes? If yes, can you describe how you are using them?
Hello @FloarinK13, I evaluate if we could use the open-MaStR to keep an up to date version of the MaStR local. The idea was to make a intial download an then keep the data current with the mirror method.