search

sciapp / sampledb

Sample and Measurement Metadata Database
https://scientific-it-systems.iffgit.fz-juelich.de/SampleDB/
MIT License
21 stars 11 forks source link

SampleDB API Python #41

Closed NilsWeber98 closed 1 year ago

NilsWeber98 commented 2 years ago

Hey, for those of you who already use SampleDB and want to digitize their lab equipment: @nilsholle and I have written a small Python library. With this you can write small programs to upload data, evaluate data or make simple changes to the samples automatically.

For all who are interested, the documentation with examples is available here. The PyPI package can be found here.

FlorianRhiem commented 2 years ago

Hey Nils, thank you for writing this API wrapper!

maltedeckers commented 2 years ago

Thank you, @NilsWeber98 and @nilsholle! Additionally to the WWU Gitlab, do you plan to publish the sourcecode in a way that allows contributions to extend the wrappers, i.e. here on github?

nilsholle commented 2 years ago

Hi Malte, as the CI pipeline is set up to run on Gitlab, I would prefer leaving the main repo there. However, I think mirroring the code to Github might be a good idea (at least other projects do it that way). Maybe it makes sense to do that as part of your sciapp organization?

FlorianRhiem commented 2 years ago

We do just that for SampleDB and other projects, developing it on our GitLab instance and mirroring it as part of the CI pipeline. As sciapp is the Scientific IT-Systems team of PGI/JCNS-TA, it'd probably be better if you mirror it to a repo for your group?

nilsholle commented 2 years ago

Ok, sounds good! We will do that some time in the next few days. As discussed via email, we will also convert the Python API to camel case, so there will be quite a lot of changes in the next version - it might make sense to wait for that before using the API.

FlorianRhiem commented 2 years ago

Great, in that case I'll wait before adding this paragraph to the HTTP API docs, and merge it once 0.6 is out. If you adapt the code style to PEP8, I've been pretty happy with the pycodestyle tool as an automated checker in the CI pipeline.

nilsholle commented 2 years ago

I just released version 0.6.0. The code is now also available here and all methods are snake case instead of camel case.

NilsWeber98 commented 1 year ago

Thank you for adding this to the HTTP API docs.