Cirrus Task Example

This repository is an example of a Cirrus task that can be used as a template. See the DEVELOPMENT.md file for instructions on developing a task.

Insert Task Desription here

Usage

To use this task in a Cirrus workflow reference the Docker location in the task configuration file in the Cirrus deployment repository. See CHANGELOG.md for version information.

Docker URL

Configuration parameters are available available to the task through the Cirrus process payload as ['tasks']['<taskname>']. The following parameters are available:

Field	Type	Description
parameter1	Map<string, int>	REQUIRED Dictionary of parameters for a series of keys
option1	float	An optional floating point parameter
option2	string	An optional parameter (Default: "")

Development

Tasks can be run locally with the built-in CLI.

$ uv run cirrus-task-example

usage: task.py run [-h] [--logging LOGGING] [--output OUTPUT] [--workdir WORKDIR] [--save-workdir] [--skip-upload] [--skip-validation] [--upload] [--no-upload] [--validate]
                   [--no-validate] [--local]
                   [input]

positional arguments:
  input              Full path of item collection to process (s3 or local) (default: None)

options:
  -h, --help         show this help message and exit
  --logging LOGGING  DEBUG, INFO, WARN, ERROR, CRITICAL (default: INFO)
  --output OUTPUT    Write output payload to this URL (default: None)
  --workdir WORKDIR  Use this as work directory. Will be created. (default: None)
  --save-workdir     Save workdir after completion (default: False)
  --skip-upload      DEPRECATED: Skip uploading of generated assets and STAC Items (default: False)
  --skip-validation  DEPRECATED: Skip validation of input payload (default: False)
  --upload           Upload generated assets and resulting STAC Items (default: True)
  --no-upload        Don't upload generated assets and resulting STAC Items (default: True)
  --validate         Validate input payload (default: True)
  --no-validate      Don't validate input payload (default: True)
  --local            Run local mode (save-workdir = True, upload = False, workdir = 'local-output', output = 'local-output/output-payload.json') (default: False)

When runing locally use the --local option which will store all output in a local folder called local-output and will not try to upload the data files to s3.

$ task.py payload.json --local

Testing

This repository uses uv and uses pytest for testing.

The tests/test_task.py file contains test code to iterate through the input payloads in fixtures, which contains a series of input and payload files, each pair in it's own folder. For expected errors in tests an exception.txt file is provided intead of an output payload.

To run the tests:

uv run pytest

Versions and Releases

This project uses CalVer for versioning releases. The format is specified as YYYY.0M.0D_MICRO, where the tokens are:

token	description	example(s)
YYYY	the full year	2006, 2016, 2106)
0M	the zero-padded month	01, 02 ... 11, 12
0D	the zero-padded day of month	01, 02 ... 30, 31
MICRO	(optional) free form, as needed	alpha, rc0, post0, ...