https://github.com/pytroll/pytroll-runner
https://github.com/pytroll/pytroll-runner
hacktoberfest
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/pytroll/pytroll-runner
- Owner: pytroll
- License: gpl-3.0
- Created: 2023-05-05T13:21:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T20:10:09.000Z (about 1 year ago)
- Last Synced: 2025-04-07T21:25:26.134Z (about 1 year ago)
- Topics: hacktoberfest
- Language: Python
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 5
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# pytroll-runner
The pytroll runner is a generic runner that allows to automate third party software in a pytroll environment.
The runner is listening for pytroll messages and running a user provided command on the files mentioned in the received
message. When the command had run, the resulting files are published as pytroll messages.
The published messages will contain metadata from the input message (except for uris and uids).
To start the runner: `pytroll-runner config.yaml`
## The configuration file
The configuration file is made of three sections.
### `script`
A dictionary with:
- `command` Full path script to run
- optionally `workers` The number of workers to use for parallel processing of messages. Defaults to 1.
### `subscriber_config`
The configuration of the subscriber. The contents of this section are passed directly to posstroll's
`create_subscriber_from_dict`.
### `publisher_config`
This section contains settings on how to publish messages.
#### `expected_files`
The glob pattern of files to be expected when the script is run. Beware that any files with matching filenames will
be included in the list, and that could include files from previous runs.
#### `static_metadata`
Metadata to include in the published messages.
#### `publisher_settings`
The configuration for the publisher. The contents of this sections are passed directly to posttroll's
`create_publisher_from_dict`.
### Example
```yaml
script: /tmp/pytest-of-a001673/pytest-169/test_fake_publisher0/myscript_bla.sh
publisher_config:
expected_files: /tmp/pytest-of-a001673/pytest-169/test_fake_publisher0/file?.bla
publisher_settings:
nameservers: false
port: 1979
static_metadata:
sensor: thermometer
topic: /hi/there
subscriber_config:
addresses:
- ipc://bla
nameserver: false
```