Ess adding in house functionalities

[nitrosx]

THis pull adds to the official main branch in the SciCat project the changes that we have implemented in-house at ESS.

The code is still a work in progress and needs mroe testing.

[nitrosx]

I forgot about the linting. Will work on it and update this PR

[dylanmcreynolds]

Awesome stuff, thanks!

I added a couple of small comments.

Also, we should add unit tests for your new methods.

https://github.com/SciCatProject/pyscicat/blob/main/pyscicat/tests/test_client.py

There's not a ton of logic in there, but the requests mock code can at least verify that we're pointing to the correct URL and test what logic is in there.

[dylanmcreynolds]

Also, can you please look into adding documentation at https://github.com/SciCatProject/pyscicat/tree/main/docs/source? Maybe a couple of how to documents about getting proposals and instruments? I think the API calls you added will get auto generated, but we should check.

[nitrosx]

I will look into the documentation

[nitrosx]

@dylanmcreynolds : I'm going to test pyScicat in a use case. I will have the examples to insert in the documentation once I'm done with that. I think it will take few days.
Do you want to wait for that to merge or should we go ahead merge and do another PR when I have the examples ready?

[dylanmcreynolds]

@dylanmcreynolds : I'm going to test pyScicat in a use case. I will have the examples to insert in the documentation once I'm done with that. I think it will take few days. Do you want to wait for that to merge or should we go ahead merge and do another PR when I have the examples ready?

I'm happy to wait. Thanks!

[nitrosx]

@dylanmcreynolds : I updated the documentation as you requested.

[nitrosx]

@dylanmcreynolds : is it ok if we merge this PR and I work and include testing in a new PR?

[dylanmcreynolds]

is it ok if we merge this PR and I work and include testing in a new PR?

I would much prefer to add unit tests now.

[dylanmcreynolds]

Thanks for the documentation!

The way it is right now, your hard work is not yet viewable in the documentation.

Check out this

pyscicat/docs/source/index.md

Line 17 in b901bac

```{toctree}

We could either add your documents as an and entry in "How To", or make a new category in the TOC called "Examples" for this documentation. What do you think?

BTW, this should be better documented, but to test the documentation build locally:

If you have not done so yet in your environment, setup the dev requirements to get the sphinx build code:

pip install -r requirements-dev.txt

Then:

cd docs
make html

This will build the web site locally into docs/build/html, and you can open a browser to the index.html

[nitrosx]

@dylanmcreynolds : I added our example under the "How-to" section.
I fixed the json code in the document, so it builds.
I also added packages pydantic and requests in requirements-dev.txt, so to build the documentation the following instructions will suffice:

pip install -r requirements-dev.txt\n
cd docs  
make html  

I think that with this we addressed all the issues.
Please let me know

[dylanmcreynolds]

Sorry, my instructions assumed that you had already run:

pip install -r requirements.txt

People tend treat requirements-dev.txt as "add-ons to the primary package". I'd rather not have dependencies repeeated in different files. Can you please remove this?

[nitrosx]

No problem. Done!!!
We should include this info in the documentation. New ticket?

[dylanmcreynolds]

We should include this info in the documentation. New ticket?

Yes, good idea:
als-computing/pyscicat#6