From bc6f784c19bd62ef266ca7426cf9f8adf95f2246 Mon Sep 17 00:00:00 2001 From: "Shiny Brar (he/il)" Date: Fri, 10 May 2024 11:34:53 -0400 Subject: [PATCH] feat(cli): added click cli support --- frbvoe/backend/voe.py | 7 +++---- frbvoe/cli/__init__.py | 0 frbvoe/cli/main.py | 17 +++++++++++++++++ frbvoe/cli/voe.py | 20 ++++++++++++++++++++ frbvoe/models/voe.py | 24 ++++++++---------------- frbvoe/utilities/email.py | 7 +++---- poetry.lock | 29 ++++++++++++++++------------- pyproject.toml | 4 ++++ 8 files changed, 71 insertions(+), 37 deletions(-) create mode 100644 frbvoe/cli/__init__.py create mode 100644 frbvoe/cli/main.py create mode 100644 frbvoe/cli/voe.py diff --git a/frbvoe/backend/voe.py b/frbvoe/backend/voe.py index 92913f1..11483a3 100644 --- a/frbvoe/backend/voe.py +++ b/frbvoe/backend/voe.py @@ -1,5 +1,6 @@ """VOEvent Server Blueprint.""" +import picologging as logging from pymongo.errors import PyMongoError from sanic import Blueprint from sanic.log import logger @@ -7,7 +8,6 @@ from sanic.response import json as json_response from sanic_ext import openapi -import picologging as logging logging.basicConfig() log = logging.getLogger() @@ -17,11 +17,12 @@ voe = Blueprint("voe", url_prefix="/") + # Post at /create_voe @voe.post("create_voe") @openapi.response(201, description="Validates VOEvent data from a host observatory.") # Add the validated payload to the MongoDB Database -async def create_voe(request: Request): #TODO: Shiny, should I add voe_event: VOEvent? +async def create_voe(request: Request): # TODO: Shiny, should I add voe_event: VOEvent? """Process a VOEvent. Args: @@ -40,8 +41,6 @@ async def create_voe(request: Request): #TODO: Shiny, should I add voe_event: VO log.info("Processing VOEvent") voe = VOEvent(**request.json) print(voe.json()) - - # Send VOEvent to Comet # comet_report = Comet(**request.json) diff --git a/frbvoe/cli/__init__.py b/frbvoe/cli/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/frbvoe/cli/main.py b/frbvoe/cli/main.py new file mode 100644 index 0000000..9a8db80 --- /dev/null +++ b/frbvoe/cli/main.py @@ -0,0 +1,17 @@ +"""FRB VOE CLI.""" + +import click +from frbvoe.cli.voe import voe + + +@click.group() +def cli(): + """FRB VOE Command Line Interface.""" + pass + +@cli.command("version", help="FRB VOE version.") +def version(): + """FRB VOE version.""" + click.echo("VOEvent Tools v0.1.0") + +cli.add_command(voe) \ No newline at end of file diff --git a/frbvoe/cli/voe.py b/frbvoe/cli/voe.py new file mode 100644 index 0000000..5393966 --- /dev/null +++ b/frbvoe/cli/voe.py @@ -0,0 +1,20 @@ +"""VOE CLI.""" + +import click + +@click.group(name="voe", help="VOEvent Tools.") +def voe(): + """Manage workflow pipelines.""" + pass + +@voe.command("send", help="Send VOEvent.") +@click.option( + "--hostname", + default="localhost", + help="Destination to send the VOE." +) +@click.option("--port", default=8098, help="Port to send the VOE.") +@click.option("--file", default="./voe",type=click.File("r"), help="VOEvent file.", show_default=True) +def send(hostname, port): + """Send VOEvent.""" + click.echo(f"Send VOEvent.{hostname}:{port}") \ No newline at end of file diff --git a/frbvoe/models/voe.py b/frbvoe/models/voe.py index 5fd9afe..be7bb8a 100644 --- a/frbvoe/models/voe.py +++ b/frbvoe/models/voe.py @@ -4,7 +4,7 @@ from typing import Literal, Optional import picologging as logging -from pydantic import EmailStr, Field, StrictFloat, StrictInt, StrictStr, BaseModel +from pydantic import BaseModel, EmailStr, Field, StrictFloat, StrictInt, StrictStr from pydantic_settings import BaseSettings, SettingsConfigDict from sanic import Request @@ -12,7 +12,7 @@ log = logging.getLogger() -class VOEvent(BaseModel): #BaseSettings +class VOEvent(BaseModel): # BaseSettings """VOEvent Object. Args: @@ -70,15 +70,9 @@ class VOEvent(BaseModel): #BaseSettings "subsequent", "retraction", "update", - ] = Field( - ..., - description="Which kind of VOEvent. Required.", - example="detection" - ) + ] = Field(..., description="Which kind of VOEvent. Required.", example="detection") observatory_name: StrictStr = Field( - ..., - description="Name of the host observatory. Required.", - example="CHIME" + ..., description="Name of the host observatory. Required.", example="CHIME" ) # date: datetime = Field( # ..., @@ -86,7 +80,7 @@ class VOEvent(BaseModel): #BaseSettings # description="Detection time of the FRB. Required.", # example="2020-01-13 16:55:08.844845", # ) - date : StrictStr = Field( + date: StrictStr = Field( ..., # release date of frb-voe description="Detection time of the FRB. Required.", @@ -179,9 +173,7 @@ class VOEvent(BaseModel): #BaseSettings example=13.8, ) flux: float = Field( - default=None, - description="Flux of the FRB in Jy. Optional.", - example=4.9 + default=None, description="Flux of the FRB in Jy. Optional.", example=4.9 ) right_ascension: float = Field( default=None, @@ -214,7 +206,7 @@ class VOEvent(BaseModel): #BaseSettings website: Optional[StrictStr] = Field( default=None, description="Link to the host observatory website. Optional.", - example="https://host_observatory.com/" + example="https://host_observatory.com/", ) tns_name: Optional[StrictStr] = Field( default=None, @@ -232,7 +224,7 @@ def payload(self): log.info("Returning VOEvent payload") return self.dict() - @staticmethod #TODO: Shiny what's this for? + @staticmethod # TODO: Shiny what's this for? async def compile(request: Request): """Extracts data from request and returns object. diff --git a/frbvoe/utilities/email.py b/frbvoe/utilities/email.py index 8a83f77..999907a 100644 --- a/frbvoe/utilities/email.py +++ b/frbvoe/utilities/email.py @@ -106,8 +106,8 @@ def send_email(email_report: Dict[str, Any]): message["To"] = receiver_email message["Subject"] = subject message.attach(MIMEText(email_message, "plain")) - - #print email message + + # print email message print(email_message) # # Connect to the SMTP server @@ -125,7 +125,6 @@ def send_email(email_report: Dict[str, Any]): return status - # \t\tbackend: {email_report['backend']}\n # \n # \tevent parameters:\n @@ -154,4 +153,4 @@ def send_email(email_report: Dict[str, Any]): # \n\n # WHY\n # \tImportance: {email_report['importance']}\n -# \n\n \ No newline at end of file +# \n\n diff --git a/poetry.lock b/poetry.lock index 61ca6b9..7d9497f 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. [[package]] name = "aiofiles" @@ -180,6 +180,20 @@ files = [ {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, ] +[[package]] +name = "click" +version = "8.1.7" +description = "Composable command line interface toolkit" +optional = false +python-versions = ">=3.7" +files = [ + {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, + {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "platform_system == \"Windows\""} + [[package]] name = "colorama" version = "0.4.6" @@ -1227,7 +1241,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -1235,16 +1248,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -1261,7 +1266,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -1269,7 +1273,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -1776,4 +1779,4 @@ testing = ["coverage (>=5.0.3)", "zope.event", "zope.testing"] [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "8b024df26068bbd16612b757be19ab56eb542bc3f1ca272ab80adbfa8886ef3d" +content-hash = "0dcadb59eaa22b5f4ce7e478aeb4096e13f2f67bd7fbb11e6f5df29b9f052f77" diff --git a/pyproject.toml b/pyproject.toml index d27c0a8..2d7d88e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,6 +15,7 @@ comet = "^3.1.0" sanic = {extras = ["ext"], version = "^23.12"} motor = "^3.4.0" numpy = "^1.26.4" +click = "^8.1.7" [tool.poetry.group.dev.dependencies] @@ -22,6 +23,9 @@ pytest = "^8.1.1" pre-commit = "^3.7.0" pytest-cov = "^5.0.0" +[tool.poetry.scripts] +frbvoe = "frbvoe.cli.main:cli" + [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api"