guillermofidalgo / reference-run-ranking Goto Github PK

OMS API: retrieve information from the OMS database

Collection of tools for obtaining OMS information in json-like format.
Note: this functionality supersedes the older version in the omsinterface folder!

References:
The code is based on the oms api repository here: https://gitlab.cern.ch/cmsoms/oms-api-client. The file omsapi.py in this folder is a direct copy of the omsapi/__init__.py file in that repository, as recommended by the developers to get it running on SWAN. See also these slides for further info on the setup of the app and this site for the available endpoints.

How to use:

• You will need to authenticate through an application registered with the OMS developer team. Either contact me on [email protected] so I can send you my application ID and client secret, or create your own as explained below.
• Open example.ipynb for some examples. You need to import get_oms_api.py, then create an OMSAPI instance via get_oms_api() (only once, can be re-used for multiple queries) and then query the information via get_oms_data( <arguments> ). See example.ipynb or get_oms_data.py for details.

How to create a personal application for authentication:

• You will need to register a personal application ID and client secret with the OMS developer team. See the slides linked above on how to do that (only slide 4-6 are relevant, the rest has been taken care of). You will receive an application ID and client secret (both are just string-like variables).
• Create a new python file in this folder called clientid.py and define two variables in there:
  API_CLIENT_ID = '<your application ID>'
  API_CLIENT_SECRET = '<your client secret>'
• That should be all!