Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waikato-datamining/shallowflow-base
The base components of the shallowflow Python workflow system
https://github.com/waikato-datamining/shallowflow-base
python3 workflow-engine
Last synced: 5 days ago
JSON representation
The base components of the shallowflow Python workflow system
- Host: GitHub
- URL: https://github.com/waikato-datamining/shallowflow-base
- Owner: waikato-datamining
- License: mit
- Created: 2023-01-10T19:47:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T03:01:17.000Z (7 months ago)
- Last Synced: 2024-04-24T13:21:36.274Z (7 months ago)
- Topics: python3, workflow-engine
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
# shallowflow-base
The base components for shallowflow.
## Installation
Install via pip:
```bash
pip install "git+https://github.com/waikato-datamining/shallowflow-base.git"
```
## Tools
### Execute flow
```
usage: sf-run-flow [-h] -f FILE [-v KEY=VALUE [KEY=VALUE ...]]
Executes the specified flow.
optional arguments:
-h, --help show this help message and exit
-f FILE, --flow FILE the flow to execute, supported extensions: .json,
.pkl, .yaml (default: None)
-v KEY=VALUE [KEY=VALUE ...], --variable KEY=VALUE [KEY=VALUE ...]
For supplying variables to the flow. (default: None)
```
### Generate markdown documentation
```
usage: sf-generate-md [-h] [-t TITLE] -l MODULE:FUNC [MODULE:FUNC ...] -o DIR
Generates Markdown documentation for the classes provided by the class lister.
optional arguments:
-h, --help show this help message and exit
-t TITLE, --title TITLE
The title for the documentation. (default:
shallowflow)
-l MODULE:FUNC [MODULE:FUNC ...], --class_lister MODULE:FUNC [MODULE:FUNC ...]
The class lister to use for obtaining the classes to
generate the help for; format:
module_name:function_name. (default: None)
-o DIR, --output DIR The directory to store the generated output in.
(default: None)
```
## Classes
[Documentation](docs/README.md)
## Examples
* [use registry](examples/use_registry.py)
* [option handling](examples/option_handling.py)
* [listing files/dirs](examples/list_files.py)
* [compatibility](examples/comp.py)
* [listing files/dirs (flow)](examples/flow_listing_files.py)
* [stopping flow](examples/stopping_flow.py)
* [use variables](examples/use_variables.py)
* [use lists in variable](examples/use_lists_in_variable.py)
* [env variables](examples/env_var.py)
* [using branches](examples/branching.py)
* [while loop](examples/while_loop.py)
* [using callable actors](examples/callable_actors.py)