p2api 1.1.9__tar.gz → 1.2.0__tar.gz

{p2api-1.1.9 → p2api-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: p2api
-Version: 1.1.9
+Version: 1.2.0
 Summary: Binding for the ESO phase 2 programmatic API
 Project-URL: Homepage, https://www.eso.org/copdemo/apidoc/index.html
 Author-email: Thomas Bierwirth <thomas.bierwirth@eso.org>, John Pritchard <john.pritchard@eso.org>
@@ -63,3 +63,41 @@ As of version 0.97.2: support for La Silla.
 Please see the [ESO-USD p2api](<http://eso.org/sci/observing/phase2/p2intro/Phase2API.html>) page for more details.
 
 Phase 2 programmatic API documentation can be found [here](<https://www.eso.org/copdemo/apidoc/>).
+
+## Create a dedicated Virtual Environment for p2api
+
+```bash
+bash
+python -m venv "${HOME}/envs/p2api"
+. "${HOME}/envs/p2api/bin/activate"
+python -m pip install --upgrade pip
+python -m pip install p2api
+```
+
+### To trigger an RRM observation
+
+First activate the environment ( if it is not already activated):
+
+```bash
+bash
+. "${HOME}/envs/p2api/bin/activate"
+```
+
+Next save your ESO User Portal credentials in the keyring if you want to be able to trigger without being prompted for the password each time:
+
+```bash
+up_username=<ESO_User_Portal_username>
+p2api_rrm_trigger -u ${up_username} -S
+```
+
+Now you are ready to make a test trigger:
+
+```bash
+up_username=<ESO_User_Portal_username>
+p2api_rrm_trigger -u ${up_username} \
+    --env=production \
+    --obId=1234567 \
+    --account_id=12345 --RA=10:20:30.000 --DEC=-35:01:30.600 \
+```
+
+To make an actual trigger, add the command line argument ```--NOT_A_TEST```.

{p2api-1.1.9 → p2api-1.2.0}/README.md

@@ -17,3 +17,41 @@ As of version 0.97.2: support for La Silla.
 Please see the [ESO-USD p2api](<http://eso.org/sci/observing/phase2/p2intro/Phase2API.html>) page for more details.
 
 Phase 2 programmatic API documentation can be found [here](<https://www.eso.org/copdemo/apidoc/>).
+
+## Create a dedicated Virtual Environment for p2api
+
+```bash
+bash
+python -m venv "${HOME}/envs/p2api"
+. "${HOME}/envs/p2api/bin/activate"
+python -m pip install --upgrade pip
+python -m pip install p2api
+```
+
+### To trigger an RRM observation
+
+First activate the environment ( if it is not already activated):
+
+```bash
+bash
+. "${HOME}/envs/p2api/bin/activate"
+```
+
+Next save your ESO User Portal credentials in the keyring if you want to be able to trigger without being prompted for the password each time:
+
+```bash
+up_username=<ESO_User_Portal_username>
+p2api_rrm_trigger -u ${up_username} -S
+```
+
+Now you are ready to make a test trigger:
+
+```bash
+up_username=<ESO_User_Portal_username>
+p2api_rrm_trigger -u ${up_username} \
+    --env=production \
+    --obId=1234567 \
+    --account_id=12345 --RA=10:20:30.000 --DEC=-35:01:30.600 \
+```
+
+To make an actual trigger, add the command line argument ```--NOT_A_TEST```.

p2api-1.2.0/p2api/__about__.py

@@ -0,0 +1 @@
+__version__ = "1.2.0"

{p2api-1.1.9 → p2api-1.2.0}/p2api/p2api.py

@@ -37,8 +37,8 @@ SOFTWARE.
 from __future__ import print_function
 import os
 import json
-import requests
 import datetime
+import requests
 
 ## The hatchling way...
 try:
@@ -2076,8 +2076,6 @@ Comments !536870979!:[$$Please add here any additional comment.$$]
     
         rlist=[]
         if finding_chart_files is not None :
-            data['fc_previous_requests']={'finding_charts': [],}
-            data['trigger_ticket_id']=trigger_ticket_id
 
             for filename in finding_chart_files.split(',') :
               if os.path.exists(filename) :
@@ -2088,7 +2086,7 @@ Comments !536870979!:[$$Please add here any additional comment.$$]
                     r=self.grrmapi_request(
                         'POST',
                         url=(
-                            'too_trigger/%d/add_fc?' %(obId)
+                            'rrm_trigger/%d/add_fc?' %(obId)
                             +'api_token=%s' %(self.access_token)
                             +'&url=%s/obsBlocks/%d' %(self.apiUrl,obId,)
                             +'&trigger_ticket_id=%d' %(trigger_ticket_id)

{p2api-1.1.9 → p2api-1.2.0}/p2api/utils/generate_finding_charts.py

@@ -18,6 +18,7 @@ import requests
 import p2api
 from p2api.__about__ import __version__
 import p2api.utils.p2api_utils as p2api_utils
+
 ################################################################################
 logger=logging.getLogger()
 ################################################################################
@@ -226,7 +227,7 @@ def oneOB( api, obId ) :
 def main():
 
     ################################################################################
-    # remove passowrd from keyring...
+    # remove password from keyring...
     if options.pwremove and options.user is not None :
         keyring.delete_password('usd_p2api_interactive:www.eso.org', options.user)
         sys.exit(0)

{p2api-1.1.9 → p2api-1.2.0}/p2api/utils/rrm_trigger.py

@@ -176,7 +176,10 @@ def oneOB( api, options, obId, overall_sdt ) :
         )
         return
 
-    if OB['obStatus'] not in ['+','R'] :
+    triggerable_OB_statuses=['+','R']
+    if options.testing :
+        triggerable_OB_statuses+=['D',]
+    if OB['obStatus'] not in triggerable_OB_statuses :
         logger.error(
             'OB status is %s, OB not triggerable',
             OB['obStatus']
@@ -230,16 +233,19 @@ def oneOB( api, options, obId, overall_sdt ) :
                         for _m in m.split('\n') :
                             logger.warning(_m)
                 #
+                #ccs_replies="\n".join(str(reply) for reply in (
+                #    _r['replies'] if isinstance(_r['replies'], (list, tuple)) else [_r['replies']]
+                #))
                 # RRM trigger status
                 if 'rrm_trigger_status' in rj :
                     if rj['rrm_trigger_status'].lower() in ['failed','invalid',] :
                         logger.error(
-                            "RRM-trigger status = %s",
+                            "rrm_trigger_status = %s",
                             rj['rrm_trigger_status']
                         )
                     else :
                         logger.info(
-                            "RRM-trigger status = %s",
+                            "rrm_trigger_status = %s",
                             rj['rrm_trigger_status']
                         )
                 if rj.get('ccs_error',None) is not None :
@@ -249,9 +255,9 @@ def oneOB( api, options, obId, overall_sdt ) :
                     for m in rj['ccs_warnings'].split('\n') :
                         logger.warning(m)
                 if rj.get('ccs_replies',None) is not None :
-                    for m in rj['ccs_replies'].split('\n') :
+                    for _m in rj['ccs_replies'] :
                         if len(_m) > 0 :
-                            logger.info(_m)
+                            logger.info("CCS_REPLY = %s",_m)
                 #
                 # DeskPro Ticket creation...
                 if (rj.get('trigger_ticket',{}) or {}).get('result',None) is not None :
@@ -274,7 +280,7 @@ def oneOB( api, options, obId, overall_sdt ) :
                             if len(_m) > 0 :
                                 logger.warning(_m)
                 if rj.get('message',None) is not None :
-                    for m in rj['message'].split('\n') :
+                    for _m in rj['message'].split('\n') :
                         if len(_m) > 0 :
                             logger.info(_m)
                 if options.debug :
@@ -395,10 +401,10 @@ def main():
             r=oneOB(api, options, obId, overall_sdt)
             if r is not None :
                 rj=r[0].json()
-                if options.finding_charts is not None and 'id' in rj.get('trigger_ticket',{}) :
+                if options.finding_charts is not None and 'id' in (rj.get('trigger_ticket') or {}) :
                     options.ticket_id=rj['trigger_ticket']['id']
                     oneOB_add_fc(api, options, obId, overall_sdt)
-            edt=datetime.datetime.now(tz_utc)
+        edt=datetime.datetime.now(tz_utc)
         logger.info(
             'Total elapsed time to process RRM trigger %s...',
             str(edt-overall_sdt)

{p2api-1.1.9 → p2api-1.2.0}/p2api/utils/rrm_trigger_add_fc.py

@@ -32,7 +32,7 @@ class get_options:
     parser.add_argument('--version', action='version', version='%(prog)s {version}'.format(version=__version__))
 
     group = parser.add_argument_group("Required input")
-    group.add_argument("--ticket_id", dest="ticket_id", help="The ticket-ID [required]", default=None)
+    group.add_argument("--ticket_id", dest="ticket_id", help="The ticket-ID [required]", type=int, default=None)
     group.add_argument("--finding_charts", dest="finding_charts", help="A comma separated list of finding chart files [required]", default=None)
     group.add_argument("--obId", dest="obId", help="OB ID to trigger [required]", default=None)
     group.add_argument("--account_id", dest="account_id", help="account_id [required]", type=int, default=None)
@@ -110,9 +110,9 @@ class get_options:
         and not (
             options.pwstore
             or
-            options.pw.pwreenter
+            options.pwreenter
             or
-            options.pw.remove
+            options.pwremove
         )
         or not options.user
     ) :
@@ -180,8 +180,11 @@ def oneOB( api, options, obId, overall_sdt ) :
         )
         return
 
-    if OB['obStatus'] not in ['+','R'] :
-        logger.warning(
+    triggerable_OB_statuses=['+','R']
+    if options.testing :
+        triggerable_OB_statuses+=['D',]
+    if OB['obStatus'] not in triggerable_OB_statuses :
+        logger.error(
             'OB status is %s, OB not triggerable',
             OB['obStatus']
         )
@@ -203,61 +206,71 @@ def oneOB( api, options, obId, overall_sdt ) :
         "Adding %d %s to DeskPro ticket for RRM OBid = %d, OBname = '%s' @ %s...",
         len(fcs_file_exists),FCorFCs,OB['obId'],OB['name'],OB['instrument']
     )
-    r = api.triggerRRM_add_fc(
-        trigger_ticket_id=options.ticket_id,
-        finding_chart_files=','.join(fcs_file_exists),
-        #
-        obId=obId,
-        account_id=options.account_id,
-        RA=options.RA,
-        DEC=options.DEC,
-        #
-        instrument=OB['instrument'],
-        OBname=OB['name'],
-        #
-        datetime_p2api_started=fits_utc(overall_sdt),
-        datetime_p2api_submitted=fits_utc(datetime.datetime.now(tz_utc)),
-    )
-    if r is not None :
-        if isinstance(r,list) :
-            i=0
-            for _r in r :
-                rj=_r.json()
-                if rj.get('error',None) is not None :
-                    for m in rj['error'].split('\n') :
-                        logger.error(m)
-                if rj.get('warning',None) is not None :
-                    for m in rj['warning'].split('\n') :
-                        logger.warning(m)
-                if rj.get('err_messages',None) is not None :
-                    for m in rj['err_messages'] :
-                        for _m in m.split('\n') :
-                            logger.error(_m)
-                if rj.get('warn_messages',None) is not None :
-                    for m in rj['warn_messages'] :
-                        for _m in m.split('\n') :
-                            logger.warning(_m)
-                if (rj.get('trigger_ticket',{}) or {}).get('err_messages',None) is not None :
-                    for m in rj['trigger_ticket']['err_messages'] :
-                        for _m in m.split('\n') :
-                            logger.error(_m)
-                if (rj.get('trigger_ticket',{}) or {}).get('warn_messages',None) is not None :
-                    for m in rj['trigger_ticket']['warn_messages'] :
-                        for _m in m.split('\n') :
-                            logger.warning(_m)
-                if rj.get('message',None) is not None :
-                    for m in rj['message'].split('\n') :
-                        logger.info(m)
-                if options.debug :
-                    print(json.dumps(rj,indent=2,))
-                    with open("/tmp/rrm_fc_{i}.json".format(i=i), 'w') as f :
-                        json.dump(rj,f,indent=2,)
-                    i+=1
-    oneOB_edt=datetime.datetime.now()
-    logger.info(
-        "%s added to DeskPro ticket for RRM OBid = %d, OBname = '%s' @ %s done in %s.",
-        FCorFCs,obId, OB['name'], OB['instrument'], str(oneOB_edt-oneOB_sdt)
-    )
+    if int(options.ticket_id) > 0 :
+        r = api.triggerRRM_add_fc(
+            trigger_ticket_id=options.ticket_id,
+            finding_chart_files=','.join(fcs_file_exists),
+            #
+            obId=obId,
+            account_id=options.account_id,
+            RA=options.RA,
+            DEC=options.DEC,
+            #
+            instrument=OB['instrument'],
+            OBname=OB['name'],
+            #
+            datetime_p2api_started=fits_utc(overall_sdt),
+            datetime_p2api_submitted=fits_utc(datetime.datetime.now(tz_utc)),
+        )
+        if r is not None :
+            if isinstance(r,list) :
+                i=0
+                for _r in r :
+                    rj=_r.json()
+                    if rj.get('error',None) is not None :
+                        for m in rj['error'].split('\n') :
+                            logger.error(m)
+                    if rj.get('warning',None) is not None :
+                        for m in rj['warning'].split('\n') :
+                            logger.warning(m)
+                    if rj.get('err_messages',None) is not None :
+                        for m in rj['err_messages'] :
+                            for _m in m.split('\n') :
+                                logger.error(_m)
+                    if rj.get('warn_messages',None) is not None :
+                        for m in rj['warn_messages'] :
+                            for _m in m.split('\n') :
+                                logger.warning(_m)
+                    if (rj.get('trigger_ticket',{}) or {}).get('err_messages',None) is not None :
+                        for m in rj['trigger_ticket']['err_messages'] :
+                            for _m in m.split('\n') :
+                                logger.error(_m)
+                    if (rj.get('trigger_ticket',{}) or {}).get('warn_messages',None) is not None :
+                        for m in rj['trigger_ticket']['warn_messages'] :
+                            for _m in m.split('\n') :
+                                logger.warning(_m)
+                    if rj.get('message',None) is not None :
+                        for m in rj['message'].split('\n') :
+                            logger.info(m)
+                    if options.debug :
+                        print(json.dumps(rj,indent=2,))
+                        with open("/tmp/rrm_fc_{i}.json".format(i=i), 'w') as f :
+                            json.dump(rj,f,indent=2,)
+                        i+=1
+        oneOB_edt=datetime.datetime.now()
+        logger.info(
+            "%s added to DeskPro ticket for RRM OBid = %d, OBname = '%s' @ %s in %s.",
+            FCorFCs,obId, OB['name'], OB['instrument'], str(oneOB_edt-oneOB_sdt)
+        )
+    else :
+        logger.info(
+            "%s NOT added to DeskPro ticket [id=%d] for RRM OBid = %d, OBname = '%s' @ %s.",
+            FCorFCs,
+            options.ticket_id,
+            obId,
+            OB['name'],
+            OB['instrument'],
+        )
 # ------------------------------------------------------------------------------
 # ------------------------------------------------------------------------------
 # ------------------------------------------------------------------------------
@@ -267,7 +280,7 @@ def main():
     options = get_options()
     overall_sdt=datetime.datetime.now(tz_utc)
     ################################################################################
-    # remove passowrd from keyring...
+    # remove password from keyring...
     if options.pwremove and options.user is not None :
         keyring.delete_password(
             'usd_p2api_interactive:www.eso.org',

{p2api-1.1.9 → p2api-1.2.0}/p2api/utils/too_trigger.py

@@ -149,7 +149,7 @@ def oneContainer( options, api, folderId, ) :
 def main():
     options = get_options()
     ################################################################################
-    # remove passowrd from keyring...
+    # remove password from keyring...
     if options.pwremove and options.user is not None :
         keyring.delete_password(
             'usd_p2api_interactive:www.eso.org',

p2api-1.1.9/p2api/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.1.9"