From 89abb0978ba793780f99c3c677c2364d0d73b155 Mon Sep 17 00:00:00 2001 From: tjacovich Date: Thu, 13 Jul 2023 10:21:33 -0400 Subject: [PATCH] Updaated readme to point to new coveralls links. Updated task functionality descriptions. --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d20ffe5..094efd5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Python CI actions](https://github.com/tjacovich/SciXIngestParserPipeline/actions/workflows/python_actions.yml/badge.svg)](https://github.com/tjacovich/SciXIngestParserPipeline/actions/workflows/python_actions.yml) [![Coverage Status](https://coveralls.io/repos/github/tjacovich/SciXIngestParserPipeline/badge.svg?branch=main)](https://coveralls.io/github/tjacovich/SciXIngestParserPipeline?branch=main) +[![Python CI actions](https://github.com/adsabs/SciXIngestParserPipeline/actions/workflows/python_actions.yml/badge.svg)](https://github.com/adsabs/SciXIngestParserPipeline/actions/workflows/python_actions.yml) [![Coverage Status](https://coveralls.io/repos/github/adsabs/SciXIngestParserPipeline/badge.svg?branch=main)](https://coveralls.io/github/adsabs/SciXIngestParserPipeline?branch=main) ![Parser Pipeline Flowchart](README_assets/Parser_Pipeline_implementation.png?raw=true "Parser Pipeline Flowchart") # Setting Up a Development Environment @@ -58,19 +58,23 @@ python3 run.py PARSER_APP ``` # Sending commands to the gRPC API -Currently, there are two methods that have been defined in the API for interacting with the Parser Pipeline. +Currently, there are three methods that have been defined in the API for interacting with the Parser Pipeline. -- `PARSER_INIT`: Initialize a job with given job_args passed into the script as a JSON. -- `PARSER_MONITOR`: Queries the status of a job with a given - -Additionally, calling either command with --persistence will open a persistent connection that streams updates for the specificed job. ```bash #This command tells the server to initialize a job by adding a message to the Parser Topic -python3 API/parser_client.py PARSER_INIT --task "SYMBOL1" --task_args '{"ingest_type": "", "daterange": "YYYY-MM-DD"}' -#This command asks the server to check on the current status of a job with -python3 API/parser_client.py PARSER_MONITOR --job_id '' +python3 API/parser_client.py REPARSE --uuid "" +#This command asks the server to check on the current status of a record with id +python3 API/parser_client.py MONITOR --uuid '' +#This command returns the current parsed record for a given +python3 API/parser_client.py VIEW --uuid '' ``` +`REPARSE` takes optional arguments: +- `--force` : forces reparsed data to be sent to the Kafka topic regardless of whether the data has changed. +- `--resend-only` : Only resends the current parsed data stored in the database without doing any parsing. + +Additionally, calling `REPARSE` or `MONITOR` command with --persistence will open a persistent connection that streams updates for the specificed uuid if only one is provided. + ## Maintainers Taylor Jacovich, Kelly Lockhart, Sergi Blanco-Cuaresma, The ADS team