1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
%global _empty_manifest_terminate_build 0
Name: python-step-exec-lib
Version: 0.1.5
Release: 1
Summary: A library that helps execute pipeline of tasks using filters and simple composition
License: Apache-2.0
URL: https://github.com/giantswarm/step-exec-lib
Source0: https://mirrors.aliyun.com/pypi/web/packages/f6/b9/b121bfbf6bd1201bd5643ccaaaf8f5d8e9a9003cecec8cc50b5bc25ede3b/step-exec-lib-0.1.5.tar.gz
BuildArch: noarch
Requires: python3-configargparse
Requires: python3-gitpython
Requires: python3-semver
%description
[](https://github.com/giantswarm/step-exec-lib/actions/workflows/main.yml)
[](https://codecov.io/gh/giantswarm/step-exec-lib)
[](https://pypi.org/project/step-exec-lib/)
[](https://pypi.org/project/step-exec-lib/)
[](https://pypi.org/project/step-exec-lib/)
# step-exec-lib
A simple library to easily orchestrate a set of Steps into a filtrable pipeline.
**Disclaimer**: docs are still work-in-progress!
Each step provides a defined set of actions. When a pipeline is execute first all `pre` actions
of all Steps are executed, then `run` actions and so on. Steps can provide labels, so
you can easily disable/enable a subset of steps.
A ready to use python app template. Based on `pipenv`.
## How to use the library
### BuildStep
The most important basic class is [BuildStep](step_exec_lib/steps.py). The class is abstract
and you have to inherit from it to provide any actual functionality. The most important methods and properties of
this class are:
* Each `BuildStep` provides a set of step names it is associated with in the `steps_provided` property.
These steps are used for filtering with `--steps`/`--skip-steps` command line options.
* `initialize_config` provides additional config options a specific class delivered from `BuildStep`
wants to provide.
* `pre_run` is optional and should be used for validation and assertions. `pre_runs` of all `BuildSteps` are executed
before any `run` method is executed. Its purpose is to allow the `abs`
to quit with error even before any actual build or tests are done. The method can't be blocking and should run
fast. If `pre_step` of any `BuildStep` fails, `run` methods of all `BuildSteps` are skipped.
* `run` is the method where actual long-running actions of the `BuildStep` are executed.
* `cleanup` is an optional method used to clean up resources that might have been needed by `run` but can't be cleaned
up until all `runs` have executed. `cleanups` are called after any `run` failed or all of them are done.
### BuildStepsFilteringPipeline
`BuildStep` class provides the `steps_provided` property, but is not in control of whether it should be executed or not
and when. `BuildSteps` have to be assembled into `pipelines`. The basic pipeline in `BuildStepsFilteringPipeline`, which
allows you to make a sequential pipeline out of your steps and filter and skip them according to `steps_provided` they
return and command line options `--steps`/`--skip-steps`. Each major part of `abs` execution is combined into a
pipeline, like `HelmBuildFilteringPipeline` used to execute build pipeline with Helm 3 or `PytestTestFilteringPipeline`
which is used to execute tests using `pytest` once the build pipeline is done.
%package -n python3-step-exec-lib
Summary: A library that helps execute pipeline of tasks using filters and simple composition
Provides: python-step-exec-lib
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-step-exec-lib
[](https://github.com/giantswarm/step-exec-lib/actions/workflows/main.yml)
[](https://codecov.io/gh/giantswarm/step-exec-lib)
[](https://pypi.org/project/step-exec-lib/)
[](https://pypi.org/project/step-exec-lib/)
[](https://pypi.org/project/step-exec-lib/)
# step-exec-lib
A simple library to easily orchestrate a set of Steps into a filtrable pipeline.
**Disclaimer**: docs are still work-in-progress!
Each step provides a defined set of actions. When a pipeline is execute first all `pre` actions
of all Steps are executed, then `run` actions and so on. Steps can provide labels, so
you can easily disable/enable a subset of steps.
A ready to use python app template. Based on `pipenv`.
## How to use the library
### BuildStep
The most important basic class is [BuildStep](step_exec_lib/steps.py). The class is abstract
and you have to inherit from it to provide any actual functionality. The most important methods and properties of
this class are:
* Each `BuildStep` provides a set of step names it is associated with in the `steps_provided` property.
These steps are used for filtering with `--steps`/`--skip-steps` command line options.
* `initialize_config` provides additional config options a specific class delivered from `BuildStep`
wants to provide.
* `pre_run` is optional and should be used for validation and assertions. `pre_runs` of all `BuildSteps` are executed
before any `run` method is executed. Its purpose is to allow the `abs`
to quit with error even before any actual build or tests are done. The method can't be blocking and should run
fast. If `pre_step` of any `BuildStep` fails, `run` methods of all `BuildSteps` are skipped.
* `run` is the method where actual long-running actions of the `BuildStep` are executed.
* `cleanup` is an optional method used to clean up resources that might have been needed by `run` but can't be cleaned
up until all `runs` have executed. `cleanups` are called after any `run` failed or all of them are done.
### BuildStepsFilteringPipeline
`BuildStep` class provides the `steps_provided` property, but is not in control of whether it should be executed or not
and when. `BuildSteps` have to be assembled into `pipelines`. The basic pipeline in `BuildStepsFilteringPipeline`, which
allows you to make a sequential pipeline out of your steps and filter and skip them according to `steps_provided` they
return and command line options `--steps`/`--skip-steps`. Each major part of `abs` execution is combined into a
pipeline, like `HelmBuildFilteringPipeline` used to execute build pipeline with Helm 3 or `PytestTestFilteringPipeline`
which is used to execute tests using `pytest` once the build pipeline is done.
%package help
Summary: Development documents and examples for step-exec-lib
Provides: python3-step-exec-lib-doc
%description help
[](https://github.com/giantswarm/step-exec-lib/actions/workflows/main.yml)
[](https://codecov.io/gh/giantswarm/step-exec-lib)
[](https://pypi.org/project/step-exec-lib/)
[](https://pypi.org/project/step-exec-lib/)
[](https://pypi.org/project/step-exec-lib/)
# step-exec-lib
A simple library to easily orchestrate a set of Steps into a filtrable pipeline.
**Disclaimer**: docs are still work-in-progress!
Each step provides a defined set of actions. When a pipeline is execute first all `pre` actions
of all Steps are executed, then `run` actions and so on. Steps can provide labels, so
you can easily disable/enable a subset of steps.
A ready to use python app template. Based on `pipenv`.
## How to use the library
### BuildStep
The most important basic class is [BuildStep](step_exec_lib/steps.py). The class is abstract
and you have to inherit from it to provide any actual functionality. The most important methods and properties of
this class are:
* Each `BuildStep` provides a set of step names it is associated with in the `steps_provided` property.
These steps are used for filtering with `--steps`/`--skip-steps` command line options.
* `initialize_config` provides additional config options a specific class delivered from `BuildStep`
wants to provide.
* `pre_run` is optional and should be used for validation and assertions. `pre_runs` of all `BuildSteps` are executed
before any `run` method is executed. Its purpose is to allow the `abs`
to quit with error even before any actual build or tests are done. The method can't be blocking and should run
fast. If `pre_step` of any `BuildStep` fails, `run` methods of all `BuildSteps` are skipped.
* `run` is the method where actual long-running actions of the `BuildStep` are executed.
* `cleanup` is an optional method used to clean up resources that might have been needed by `run` but can't be cleaned
up until all `runs` have executed. `cleanups` are called after any `run` failed or all of them are done.
### BuildStepsFilteringPipeline
`BuildStep` class provides the `steps_provided` property, but is not in control of whether it should be executed or not
and when. `BuildSteps` have to be assembled into `pipelines`. The basic pipeline in `BuildStepsFilteringPipeline`, which
allows you to make a sequential pipeline out of your steps and filter and skip them according to `steps_provided` they
return and command line options `--steps`/`--skip-steps`. Each major part of `abs` execution is combined into a
pipeline, like `HelmBuildFilteringPipeline` used to execute build pipeline with Helm 3 or `PytestTestFilteringPipeline`
which is used to execute tests using `pytest` once the build pipeline is done.
%prep
%autosetup -n step-exec-lib-0.1.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-step-exec-lib -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.5-1
- Package Spec generated
|
