robotframework-extensions-collection 0.10.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- robotframework-extensions-collection-0.10.0/LICENSE +201 -0
- robotframework-extensions-collection-0.10.0/PKG-INFO +145 -0
- robotframework-extensions-collection-0.10.0/README.rst +125 -0
- robotframework-extensions-collection-0.10.0/RobotframeworkExtensions/Collection.py +212 -0
- robotframework-extensions-collection-0.10.0/RobotframeworkExtensions/RobotframeworkExtensions.pdf +0 -0
- robotframework-extensions-collection-0.10.0/RobotframeworkExtensions/__init__.py +13 -0
- robotframework-extensions-collection-0.10.0/RobotframeworkExtensions/version.py +23 -0
- robotframework-extensions-collection-0.10.0/robotframework_extensions_collection.egg-info/PKG-INFO +145 -0
- robotframework-extensions-collection-0.10.0/robotframework_extensions_collection.egg-info/SOURCES.txt +12 -0
- robotframework-extensions-collection-0.10.0/robotframework_extensions_collection.egg-info/dependency_links.txt +1 -0
- robotframework-extensions-collection-0.10.0/robotframework_extensions_collection.egg-info/requires.txt +2 -0
- robotframework-extensions-collection-0.10.0/robotframework_extensions_collection.egg-info/top_level.txt +1 -0
- robotframework-extensions-collection-0.10.0/setup.cfg +4 -0
- robotframework-extensions-collection-0.10.0/setup.py +224 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: robotframework-extensions-collection
|
|
3
|
+
Version: 0.10.0
|
|
4
|
+
Summary: Additional Robot Framework keywords
|
|
5
|
+
Home-page: https://github.com/test-fullautomation/robotframework-extensions-collection
|
|
6
|
+
Author: Holger Queckenstedt
|
|
7
|
+
Author-email: Holger.Queckenstedt@de.bosch.com
|
|
8
|
+
License: UNKNOWN
|
|
9
|
+
Platform: UNKNOWN
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Topic :: Software Development
|
|
16
|
+
Requires-Python: >=3.0
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
License-File: LICENSE
|
|
19
|
+
|
|
20
|
+
Package Description
|
|
21
|
+
===================
|
|
22
|
+
|
|
23
|
+
The **RobotframeworkExtensions** extend the functionality of the Robot
|
|
24
|
+
Framework by some useful keywords.
|
|
25
|
+
|
|
26
|
+
How to install
|
|
27
|
+
--------------
|
|
28
|
+
|
|
29
|
+
The **RobotframeworkExtensions** can be installed in two different ways.
|
|
30
|
+
|
|
31
|
+
1. Installation via PyPi (recommended for users)
|
|
32
|
+
|
|
33
|
+
``` {.}
|
|
34
|
+
pip install RobotframeworkExtensions
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[RobotframeworkExtensions in
|
|
38
|
+
PyPi](https://pypi.org/project/RobotframeworkExtensions/)
|
|
39
|
+
|
|
40
|
+
2. Installation via GitHub (recommended for developers)
|
|
41
|
+
|
|
42
|
+
- Clone the **robotframework-extensions-collection** repository to
|
|
43
|
+
your machine.
|
|
44
|
+
|
|
45
|
+
``` {.}
|
|
46
|
+
git clone https://github.com/test-fullautomation/robotframework-extensions-collection.git
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[RobotframeworkExtensions in
|
|
50
|
+
GitHub](https://github.com/test-fullautomation/robotframework-extensions-collection)
|
|
51
|
+
|
|
52
|
+
- Install dependencies
|
|
53
|
+
|
|
54
|
+
**RobotframeworkExtensions** requires some additional Python
|
|
55
|
+
libraries. Before you install the cloned repository sources you
|
|
56
|
+
have to install the dependencies manually. The names of all
|
|
57
|
+
related packages you can find in the file `requirements.txt` in
|
|
58
|
+
the repository root folder. Use pip to install them:
|
|
59
|
+
|
|
60
|
+
``` {.}
|
|
61
|
+
pip install -r ./requirements.txt
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Additionally install **LaTeX** (recommended: TeX Live). This is
|
|
65
|
+
used to render the documentation.
|
|
66
|
+
|
|
67
|
+
- Configure dependencies
|
|
68
|
+
|
|
69
|
+
The installation of **RobotframeworkExtensions** includes to
|
|
70
|
+
generate the documentation in PDF format. This is done by an
|
|
71
|
+
application called **GenPackageDoc**, that is part of the
|
|
72
|
+
installation dependencies (see `requirements.txt`).
|
|
73
|
+
|
|
74
|
+
**GenPackageDoc** uses **LaTeX** to generate the documentation
|
|
75
|
+
in PDF format. Therefore **GenPackageDoc** needs to know where
|
|
76
|
+
to find **LaTeX**. This is defined in the **GenPackageDoc**
|
|
77
|
+
configuration file
|
|
78
|
+
|
|
79
|
+
``` {.}
|
|
80
|
+
packagedoc\packagedoc_config.json
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Before you start the installation you have to introduce the
|
|
84
|
+
following environment variable, that is used in
|
|
85
|
+
`packagedoc_config.json`:
|
|
86
|
+
|
|
87
|
+
- `GENDOC_LATEXPATH` : path to `pdflatex` executable
|
|
88
|
+
|
|
89
|
+
- Use the following command to install the
|
|
90
|
+
**RobotframeworkExtensions**:
|
|
91
|
+
|
|
92
|
+
``` {.}
|
|
93
|
+
setup.py install
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Package Documentation
|
|
97
|
+
---------------------
|
|
98
|
+
|
|
99
|
+
A detailed documentation of the **RobotframeworkExtensions** can be
|
|
100
|
+
found here:
|
|
101
|
+
|
|
102
|
+
[RobotframeworkExtensions.pdf](https://github.com/test-fullautomation/robotframework-extensions-collection/blob/develop/RobotframeworkExtensions/RobotframeworkExtensions.pdf)
|
|
103
|
+
|
|
104
|
+
Feedback
|
|
105
|
+
--------
|
|
106
|
+
|
|
107
|
+
To give us a feedback, you can send an email to [Thomas
|
|
108
|
+
Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
|
|
109
|
+
|
|
110
|
+
In case you want to report a bug or request any interesting feature,
|
|
111
|
+
please don\'t hesitate to raise a ticket.
|
|
112
|
+
|
|
113
|
+
Maintainers
|
|
114
|
+
-----------
|
|
115
|
+
|
|
116
|
+
[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
|
|
117
|
+
|
|
118
|
+
[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
|
|
119
|
+
|
|
120
|
+
Contributors
|
|
121
|
+
------------
|
|
122
|
+
|
|
123
|
+
[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
|
|
124
|
+
|
|
125
|
+
[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
|
|
126
|
+
|
|
127
|
+
License
|
|
128
|
+
-------
|
|
129
|
+
|
|
130
|
+
Copyright 2020-2022 Robert Bosch GmbH
|
|
131
|
+
|
|
132
|
+
Licensed under the Apache License, Version 2.0 (the \"License\"); you
|
|
133
|
+
may not use this file except in compliance with the License. You may
|
|
134
|
+
obtain a copy of the License at
|
|
135
|
+
|
|
136
|
+
> [](http://www.apache.org/licenses/LICENSE-2.0.html)
|
|
138
|
+
|
|
139
|
+
Unless required by applicable law or agreed to in writing, software
|
|
140
|
+
distributed under the License is distributed on an \"AS IS\" BASIS,
|
|
141
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
142
|
+
See the License for the specific language governing permissions and
|
|
143
|
+
limitations under the License.
|
|
144
|
+
|
|
145
|
+
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
.. Copyright 2020-2022 Robert Bosch GmbH
|
|
2
|
+
|
|
3
|
+
.. Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
.. http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
.. Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
|
14
|
+
|
|
15
|
+
Package Description
|
|
16
|
+
===================
|
|
17
|
+
|
|
18
|
+
The **RobotframeworkExtensions** extend the functionality of the Robot Framework by some useful keywords.
|
|
19
|
+
|
|
20
|
+
How to install
|
|
21
|
+
--------------
|
|
22
|
+
|
|
23
|
+
The **RobotframeworkExtensions** can be installed in two different ways.
|
|
24
|
+
|
|
25
|
+
1. Installation via PyPi (recommended for users)
|
|
26
|
+
|
|
27
|
+
.. code::
|
|
28
|
+
|
|
29
|
+
pip install RobotframeworkExtensions
|
|
30
|
+
|
|
31
|
+
`RobotframeworkExtensions in PyPi <https://pypi.org/project/RobotframeworkExtensions/>`_
|
|
32
|
+
|
|
33
|
+
2. Installation via GitHub (recommended for developers)
|
|
34
|
+
|
|
35
|
+
* Clone the **robotframework-extensions-collection** repository to your machine.
|
|
36
|
+
|
|
37
|
+
.. code::
|
|
38
|
+
|
|
39
|
+
git clone https://github.com/test-fullautomation/robotframework-extensions-collection.git
|
|
40
|
+
|
|
41
|
+
`RobotframeworkExtensions in GitHub <https://github.com/test-fullautomation/robotframework-extensions-collection>`_
|
|
42
|
+
|
|
43
|
+
* Install dependencies
|
|
44
|
+
|
|
45
|
+
**RobotframeworkExtensions** requires some additional Python libraries. Before you install the cloned repository sources
|
|
46
|
+
you have to install the dependencies manually. The names of all related packages you can find in the file ``requirements.txt``
|
|
47
|
+
in the repository root folder. Use pip to install them:
|
|
48
|
+
|
|
49
|
+
.. code::
|
|
50
|
+
|
|
51
|
+
pip install -r ./requirements.txt
|
|
52
|
+
|
|
53
|
+
Additionally install **LaTeX** (recommended: TeX Live). This is used to render the documentation.
|
|
54
|
+
|
|
55
|
+
* Configure dependencies
|
|
56
|
+
|
|
57
|
+
The installation of **RobotframeworkExtensions** includes to generate the documentation in PDF format. This is done by
|
|
58
|
+
an application called **GenPackageDoc**, that is part of the installation dependencies (see ``requirements.txt``).
|
|
59
|
+
|
|
60
|
+
**GenPackageDoc** uses **LaTeX** to generate the documentation in PDF format. Therefore **GenPackageDoc** needs to know where to find
|
|
61
|
+
**LaTeX**. This is defined in the **GenPackageDoc** configuration file
|
|
62
|
+
|
|
63
|
+
.. code::
|
|
64
|
+
|
|
65
|
+
packagedoc\packagedoc_config.json
|
|
66
|
+
|
|
67
|
+
Before you start the installation you have to introduce the following environment variable, that is used in ``packagedoc_config.json``:
|
|
68
|
+
|
|
69
|
+
- ``GENDOC_LATEXPATH`` : path to ``pdflatex`` executable
|
|
70
|
+
|
|
71
|
+
* Use the following command to install the **RobotframeworkExtensions**:
|
|
72
|
+
|
|
73
|
+
.. code::
|
|
74
|
+
|
|
75
|
+
setup.py install
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
Package Documentation
|
|
79
|
+
---------------------
|
|
80
|
+
|
|
81
|
+
A detailed documentation of the **RobotframeworkExtensions** can be found here:
|
|
82
|
+
|
|
83
|
+
`RobotframeworkExtensions.pdf <https://github.com/test-fullautomation/robotframework-extensions-collection/blob/develop/RobotframeworkExtensions/RobotframeworkExtensions.pdf>`_
|
|
84
|
+
|
|
85
|
+
Feedback
|
|
86
|
+
--------
|
|
87
|
+
|
|
88
|
+
To give us a feedback, you can send an email to `Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_
|
|
89
|
+
|
|
90
|
+
In case you want to report a bug or request any interesting feature, please don't hesitate to raise a ticket.
|
|
91
|
+
|
|
92
|
+
Maintainers
|
|
93
|
+
-----------
|
|
94
|
+
|
|
95
|
+
`Holger Queckenstedt <mailto:Holger.Queckenstedt@de.bosch.com>`_
|
|
96
|
+
|
|
97
|
+
`Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_
|
|
98
|
+
|
|
99
|
+
Contributors
|
|
100
|
+
------------
|
|
101
|
+
|
|
102
|
+
`Holger Queckenstedt <mailto:Holger.Queckenstedt@de.bosch.com>`_
|
|
103
|
+
|
|
104
|
+
`Thomas Pollerspöck <mailto:Thomas.Pollerspoeck@de.bosch.com>`_
|
|
105
|
+
|
|
106
|
+
License
|
|
107
|
+
-------
|
|
108
|
+
|
|
109
|
+
Copyright 2020-2022 Robert Bosch GmbH
|
|
110
|
+
|
|
111
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
112
|
+
you may not use this file except in compliance with the License.
|
|
113
|
+
You may obtain a copy of the License at
|
|
114
|
+
|
|
115
|
+
|License: Apache v2|
|
|
116
|
+
|
|
117
|
+
Unless required by applicable law or agreed to in writing, software
|
|
118
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
119
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
120
|
+
See the License for the specific language governing permissions and
|
|
121
|
+
limitations under the License.
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
.. |License: Apache v2| image:: https://img.shields.io/pypi/l/robotframework.svg
|
|
125
|
+
:target: http://www.apache.org/licenses/LICENSE-2.0.html
|
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# **************************************************************************************************************
|
|
2
|
+
#
|
|
3
|
+
# Copyright 2020-2022 Robert Bosch GmbH
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
#
|
|
17
|
+
# **************************************************************************************************************
|
|
18
|
+
#
|
|
19
|
+
# Collection.py
|
|
20
|
+
#
|
|
21
|
+
# XC-CT/ECA3-Queckenstedt
|
|
22
|
+
#
|
|
23
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
24
|
+
#
|
|
25
|
+
# 06.04.2023
|
|
26
|
+
#
|
|
27
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
28
|
+
|
|
29
|
+
"""
|
|
30
|
+
The Collection module is the interface between the PythonExtensionsCollection and the Robot Framework.
|
|
31
|
+
|
|
32
|
+
This library containing the keyword definitions, can be imported in the following way:
|
|
33
|
+
|
|
34
|
+
.. code::
|
|
35
|
+
|
|
36
|
+
Library RobotframeworkExtensions.Collection WITH NAME rf.extensions
|
|
37
|
+
|
|
38
|
+
"""
|
|
39
|
+
|
|
40
|
+
# -- import standard Python modules
|
|
41
|
+
import pickle, os, time, random
|
|
42
|
+
|
|
43
|
+
# -- import Robotframework API
|
|
44
|
+
from robot.api.deco import keyword, library # required when using @keyword, @library decorators
|
|
45
|
+
from robot.libraries.BuiltIn import BuiltIn
|
|
46
|
+
|
|
47
|
+
# -- import own Python modules
|
|
48
|
+
from PythonExtensionsCollection.Utils.CUtils import *
|
|
49
|
+
from PythonExtensionsCollection.String.CString import CString
|
|
50
|
+
|
|
51
|
+
from RobotframeworkExtensions.version import VERSION
|
|
52
|
+
from RobotframeworkExtensions.version import VERSION_DATE
|
|
53
|
+
|
|
54
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
55
|
+
|
|
56
|
+
sThisModuleName = "Collection.py"
|
|
57
|
+
sThisModuleVersion = VERSION
|
|
58
|
+
sThisModuleDate = VERSION_DATE
|
|
59
|
+
sThisModule = sThisModuleName + " v. " + sThisModuleVersion + " / " + sThisModuleDate
|
|
60
|
+
|
|
61
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
62
|
+
#
|
|
63
|
+
@library
|
|
64
|
+
class Collection(object):
|
|
65
|
+
"""Module main class
|
|
66
|
+
"""
|
|
67
|
+
|
|
68
|
+
ROBOT_AUTO_KEYWORDS = False # only decorated methods are keywords
|
|
69
|
+
ROBOT_LIBRARY_VERSION = sThisModuleVersion
|
|
70
|
+
ROBOT_LIBRARY_SCOPE = 'GLOBAL'
|
|
71
|
+
|
|
72
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
73
|
+
#TM***
|
|
74
|
+
|
|
75
|
+
def __init__(self, sThisModule=sThisModule):
|
|
76
|
+
self.sThisModule = sThisModule # in case of debugging
|
|
77
|
+
|
|
78
|
+
def __del__(self):
|
|
79
|
+
pass
|
|
80
|
+
|
|
81
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
82
|
+
#TM***
|
|
83
|
+
|
|
84
|
+
@keyword
|
|
85
|
+
def pretty_print(self, oData=None, sPrefix=None):
|
|
86
|
+
"""
|
|
87
|
+
The ``pretty_print`` keyword logs the content of parameters of any Python data type (input: ``oData``).
|
|
88
|
+
|
|
89
|
+
Simple data types are logged directly. Composite data types are resolved before.
|
|
90
|
+
|
|
91
|
+
The output contains for every parameter:
|
|
92
|
+
|
|
93
|
+
* the type
|
|
94
|
+
* the total number of elements inside (e.g. the number of keys inside a dictionary)
|
|
95
|
+
* the counter number of the current element
|
|
96
|
+
* the value
|
|
97
|
+
|
|
98
|
+
The trace level for output is ``INFO``.
|
|
99
|
+
|
|
100
|
+
The output is also returned as list of strings.
|
|
101
|
+
|
|
102
|
+
**Arguments:**
|
|
103
|
+
|
|
104
|
+
* ``oData``
|
|
105
|
+
|
|
106
|
+
/ *Condition*: required / *Type*: any Python type /
|
|
107
|
+
|
|
108
|
+
Data to be pretty printed
|
|
109
|
+
|
|
110
|
+
* ``sPrefix``
|
|
111
|
+
|
|
112
|
+
/ *Condition*: optional / *Type*: str / *Default*: None /
|
|
113
|
+
|
|
114
|
+
If not ``None``, this prefix string is added to every output line.
|
|
115
|
+
|
|
116
|
+
**Returns:**
|
|
117
|
+
|
|
118
|
+
* ``listOutLines`` (*list*)
|
|
119
|
+
|
|
120
|
+
/ *Type*: list /
|
|
121
|
+
|
|
122
|
+
List of strings containing the resolved data structure of ``oData`` (same content as printed to console).
|
|
123
|
+
"""
|
|
124
|
+
|
|
125
|
+
# BuiltIn().log(f"This is {self.sThisModule}", "INFO") # debug
|
|
126
|
+
|
|
127
|
+
oTypePrint = CTypePrint()
|
|
128
|
+
listOutLines = oTypePrint.TypePrint(oData)
|
|
129
|
+
|
|
130
|
+
if sPrefix is None:
|
|
131
|
+
for sLine in listOutLines:
|
|
132
|
+
BuiltIn().log(sLine, "INFO")
|
|
133
|
+
BuiltIn().log_to_console(sLine)
|
|
134
|
+
return listOutLines
|
|
135
|
+
else:
|
|
136
|
+
listOutLinesNew = []
|
|
137
|
+
for sLine in listOutLines:
|
|
138
|
+
sLine = f"{sPrefix} : {sLine}"
|
|
139
|
+
BuiltIn().log(sLine, "INFO")
|
|
140
|
+
BuiltIn().log_to_console(sLine)
|
|
141
|
+
listOutLinesNew.append(sLine)
|
|
142
|
+
return listOutLinesNew
|
|
143
|
+
|
|
144
|
+
# eof def pretty_print(self, oData=None, sPrefix=None):
|
|
145
|
+
|
|
146
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
147
|
+
#TM***
|
|
148
|
+
|
|
149
|
+
@keyword
|
|
150
|
+
def normalize_path(self, sPath=None, bWin=False, sReferencePathAbs=None, bConsiderBlanks=False, bExpandEnvVars=True, bMask=True):
|
|
151
|
+
"""
|
|
152
|
+
The ``normalize_path`` keyword normalizes local paths, paths to local network resources and internet addresses
|
|
153
|
+
|
|
154
|
+
**Arguments:**
|
|
155
|
+
|
|
156
|
+
* ``sPath``
|
|
157
|
+
|
|
158
|
+
/ *Condition*: required / *Type*: str /
|
|
159
|
+
|
|
160
|
+
The path to be normalized
|
|
161
|
+
|
|
162
|
+
* ``bWin``
|
|
163
|
+
|
|
164
|
+
/ *Condition*: optional / *Type*: bool / *Default*: False /
|
|
165
|
+
|
|
166
|
+
If ``True`` then the returned path contains masked backslashes as separator, otherwise slashes
|
|
167
|
+
|
|
168
|
+
* ``sReferencePathAbs``
|
|
169
|
+
|
|
170
|
+
/ *Condition*: optional / *Type*: str / *Default*: None /
|
|
171
|
+
|
|
172
|
+
In case of ``sPath`` is relative and ``sReferencePathAbs`` (expected to be absolute) is given, then
|
|
173
|
+
the returned absolute path is a join of both input paths
|
|
174
|
+
|
|
175
|
+
* ``bConsiderBlanks``
|
|
176
|
+
|
|
177
|
+
/ *Condition*: optional / *Type*: bool / *Default*: False /
|
|
178
|
+
|
|
179
|
+
If ``True`` then the returned path is encapsulated in quotes - in case of the path contains blanks
|
|
180
|
+
|
|
181
|
+
* ``bExpandEnvVars``
|
|
182
|
+
|
|
183
|
+
/ *Condition*: optional / *Type*: bool / *Default*: True /
|
|
184
|
+
|
|
185
|
+
If ``True`` then in the returned path environment variables are resolved, otherwise not.
|
|
186
|
+
|
|
187
|
+
* ``bMask``
|
|
188
|
+
|
|
189
|
+
/ *Condition*: optional / *Type*: bool / *Default*: True (requires ``bWin=True``) /
|
|
190
|
+
|
|
191
|
+
If ``bWin`` is ``True`` and ``bMask`` is ``True`` then the returned path contains masked backslashes as separator.
|
|
192
|
+
|
|
193
|
+
If ``bWin`` is ``True`` and ``bMask`` is ``False`` then the returned path contains single backslashes only - this might be
|
|
194
|
+
required for applications, that are not able to handle masked backslashes.
|
|
195
|
+
|
|
196
|
+
In case of ``bWin`` is ``False`` ``bMask`` has no effect.
|
|
197
|
+
|
|
198
|
+
**Returns:**
|
|
199
|
+
|
|
200
|
+
* ``sPath``
|
|
201
|
+
|
|
202
|
+
/ *Type*: str /
|
|
203
|
+
|
|
204
|
+
The normalized path (is ``None`` in case of ``sPath`` is ``None``)
|
|
205
|
+
"""
|
|
206
|
+
sPath = CString.NormalizePath(sPath, bWin, sReferencePathAbs, bConsiderBlanks, bExpandEnvVars, bMask)
|
|
207
|
+
return sPath
|
|
208
|
+
|
|
209
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
210
|
+
|
|
211
|
+
# eof class Collection(object):
|
|
212
|
+
|
robotframework-extensions-collection-0.10.0/RobotframeworkExtensions/RobotframeworkExtensions.pdf
ADDED
|
Binary file
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Copyright 2020-2022 Robert Bosch GmbH
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# **************************************************************************************************************
|
|
2
|
+
#
|
|
3
|
+
# Copyright 2020-2022 Robert Bosch GmbH
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
#
|
|
17
|
+
# **************************************************************************************************************
|
|
18
|
+
#
|
|
19
|
+
# Version and date of RobotframeworkExtensions
|
|
20
|
+
#
|
|
21
|
+
VERSION = "0.10.0"
|
|
22
|
+
VERSION_DATE = "06.04.2023"
|
|
23
|
+
|
robotframework-extensions-collection-0.10.0/robotframework_extensions_collection.egg-info/PKG-INFO
ADDED
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: robotframework-extensions-collection
|
|
3
|
+
Version: 0.10.0
|
|
4
|
+
Summary: Additional Robot Framework keywords
|
|
5
|
+
Home-page: https://github.com/test-fullautomation/robotframework-extensions-collection
|
|
6
|
+
Author: Holger Queckenstedt
|
|
7
|
+
Author-email: Holger.Queckenstedt@de.bosch.com
|
|
8
|
+
License: UNKNOWN
|
|
9
|
+
Platform: UNKNOWN
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Topic :: Software Development
|
|
16
|
+
Requires-Python: >=3.0
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
License-File: LICENSE
|
|
19
|
+
|
|
20
|
+
Package Description
|
|
21
|
+
===================
|
|
22
|
+
|
|
23
|
+
The **RobotframeworkExtensions** extend the functionality of the Robot
|
|
24
|
+
Framework by some useful keywords.
|
|
25
|
+
|
|
26
|
+
How to install
|
|
27
|
+
--------------
|
|
28
|
+
|
|
29
|
+
The **RobotframeworkExtensions** can be installed in two different ways.
|
|
30
|
+
|
|
31
|
+
1. Installation via PyPi (recommended for users)
|
|
32
|
+
|
|
33
|
+
``` {.}
|
|
34
|
+
pip install RobotframeworkExtensions
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[RobotframeworkExtensions in
|
|
38
|
+
PyPi](https://pypi.org/project/RobotframeworkExtensions/)
|
|
39
|
+
|
|
40
|
+
2. Installation via GitHub (recommended for developers)
|
|
41
|
+
|
|
42
|
+
- Clone the **robotframework-extensions-collection** repository to
|
|
43
|
+
your machine.
|
|
44
|
+
|
|
45
|
+
``` {.}
|
|
46
|
+
git clone https://github.com/test-fullautomation/robotframework-extensions-collection.git
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
[RobotframeworkExtensions in
|
|
50
|
+
GitHub](https://github.com/test-fullautomation/robotframework-extensions-collection)
|
|
51
|
+
|
|
52
|
+
- Install dependencies
|
|
53
|
+
|
|
54
|
+
**RobotframeworkExtensions** requires some additional Python
|
|
55
|
+
libraries. Before you install the cloned repository sources you
|
|
56
|
+
have to install the dependencies manually. The names of all
|
|
57
|
+
related packages you can find in the file `requirements.txt` in
|
|
58
|
+
the repository root folder. Use pip to install them:
|
|
59
|
+
|
|
60
|
+
``` {.}
|
|
61
|
+
pip install -r ./requirements.txt
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Additionally install **LaTeX** (recommended: TeX Live). This is
|
|
65
|
+
used to render the documentation.
|
|
66
|
+
|
|
67
|
+
- Configure dependencies
|
|
68
|
+
|
|
69
|
+
The installation of **RobotframeworkExtensions** includes to
|
|
70
|
+
generate the documentation in PDF format. This is done by an
|
|
71
|
+
application called **GenPackageDoc**, that is part of the
|
|
72
|
+
installation dependencies (see `requirements.txt`).
|
|
73
|
+
|
|
74
|
+
**GenPackageDoc** uses **LaTeX** to generate the documentation
|
|
75
|
+
in PDF format. Therefore **GenPackageDoc** needs to know where
|
|
76
|
+
to find **LaTeX**. This is defined in the **GenPackageDoc**
|
|
77
|
+
configuration file
|
|
78
|
+
|
|
79
|
+
``` {.}
|
|
80
|
+
packagedoc\packagedoc_config.json
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Before you start the installation you have to introduce the
|
|
84
|
+
following environment variable, that is used in
|
|
85
|
+
`packagedoc_config.json`:
|
|
86
|
+
|
|
87
|
+
- `GENDOC_LATEXPATH` : path to `pdflatex` executable
|
|
88
|
+
|
|
89
|
+
- Use the following command to install the
|
|
90
|
+
**RobotframeworkExtensions**:
|
|
91
|
+
|
|
92
|
+
``` {.}
|
|
93
|
+
setup.py install
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Package Documentation
|
|
97
|
+
---------------------
|
|
98
|
+
|
|
99
|
+
A detailed documentation of the **RobotframeworkExtensions** can be
|
|
100
|
+
found here:
|
|
101
|
+
|
|
102
|
+
[RobotframeworkExtensions.pdf](https://github.com/test-fullautomation/robotframework-extensions-collection/blob/develop/RobotframeworkExtensions/RobotframeworkExtensions.pdf)
|
|
103
|
+
|
|
104
|
+
Feedback
|
|
105
|
+
--------
|
|
106
|
+
|
|
107
|
+
To give us a feedback, you can send an email to [Thomas
|
|
108
|
+
Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
|
|
109
|
+
|
|
110
|
+
In case you want to report a bug or request any interesting feature,
|
|
111
|
+
please don\'t hesitate to raise a ticket.
|
|
112
|
+
|
|
113
|
+
Maintainers
|
|
114
|
+
-----------
|
|
115
|
+
|
|
116
|
+
[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
|
|
117
|
+
|
|
118
|
+
[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
|
|
119
|
+
|
|
120
|
+
Contributors
|
|
121
|
+
------------
|
|
122
|
+
|
|
123
|
+
[Holger Queckenstedt](mailto:Holger.Queckenstedt@de.bosch.com)
|
|
124
|
+
|
|
125
|
+
[Thomas Pollerspöck](mailto:Thomas.Pollerspoeck@de.bosch.com)
|
|
126
|
+
|
|
127
|
+
License
|
|
128
|
+
-------
|
|
129
|
+
|
|
130
|
+
Copyright 2020-2022 Robert Bosch GmbH
|
|
131
|
+
|
|
132
|
+
Licensed under the Apache License, Version 2.0 (the \"License\"); you
|
|
133
|
+
may not use this file except in compliance with the License. You may
|
|
134
|
+
obtain a copy of the License at
|
|
135
|
+
|
|
136
|
+
> [](http://www.apache.org/licenses/LICENSE-2.0.html)
|
|
138
|
+
|
|
139
|
+
Unless required by applicable law or agreed to in writing, software
|
|
140
|
+
distributed under the License is distributed on an \"AS IS\" BASIS,
|
|
141
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
142
|
+
See the License for the specific language governing permissions and
|
|
143
|
+
limitations under the License.
|
|
144
|
+
|
|
145
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.rst
|
|
3
|
+
setup.py
|
|
4
|
+
RobotframeworkExtensions/Collection.py
|
|
5
|
+
RobotframeworkExtensions/RobotframeworkExtensions.pdf
|
|
6
|
+
RobotframeworkExtensions/__init__.py
|
|
7
|
+
RobotframeworkExtensions/version.py
|
|
8
|
+
robotframework_extensions_collection.egg-info/PKG-INFO
|
|
9
|
+
robotframework_extensions_collection.egg-info/SOURCES.txt
|
|
10
|
+
robotframework_extensions_collection.egg-info/dependency_links.txt
|
|
11
|
+
robotframework_extensions_collection.egg-info/requires.txt
|
|
12
|
+
robotframework_extensions_collection.egg-info/top_level.txt
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
RobotframeworkExtensions
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
# **************************************************************************************************************
|
|
2
|
+
#
|
|
3
|
+
# Copyright 2020-2022 Robert Bosch GmbH
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
#
|
|
17
|
+
# **************************************************************************************************************
|
|
18
|
+
#
|
|
19
|
+
# setup.py
|
|
20
|
+
#
|
|
21
|
+
# XC-CT/ECA3-Queckenstedt
|
|
22
|
+
#
|
|
23
|
+
# Extends the standard setuptools installation by adding the documentation in PDF format
|
|
24
|
+
# (requires installation mode) and tidying up some folders.
|
|
25
|
+
#
|
|
26
|
+
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
27
|
+
#
|
|
28
|
+
# This script deletes folders (as defined in config.CRepositoryConfig, depending on the position of this script):
|
|
29
|
+
# - previous builds within this repository
|
|
30
|
+
# - previous installations within
|
|
31
|
+
# * <Python installation>\Lib\site-packages (Windows)
|
|
32
|
+
# * <Python installation>/../lib/python3.9/site-packages (Linux)
|
|
33
|
+
#
|
|
34
|
+
# before the build and the installation start again!
|
|
35
|
+
#
|
|
36
|
+
# !!! USE WITH CAUTION !!!
|
|
37
|
+
#
|
|
38
|
+
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
39
|
+
#
|
|
40
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
41
|
+
#
|
|
42
|
+
# * Hints:
|
|
43
|
+
#
|
|
44
|
+
# The usual
|
|
45
|
+
# packages = setuptools.find_packages(),
|
|
46
|
+
# is replaced by
|
|
47
|
+
# packages = [str(oRepositoryConfig.Get('PACKAGENAME')), ],
|
|
48
|
+
# to avoid that also config.CRepositoryConfig() and additions.CExtendedSetup() are part of the distribution.
|
|
49
|
+
# CRepositoryConfig and CExtendedSetup() are only repository internal helper.
|
|
50
|
+
#
|
|
51
|
+
# * Known issues:
|
|
52
|
+
#
|
|
53
|
+
# - setuptools do not properly update an existing package installation under <Python installation>\Lib\site-packages\<package name>!
|
|
54
|
+
# > Files modified manually within installation folder, are still modified after repeated execution of setuptools.
|
|
55
|
+
# > Files added manually within installation folder, are still present there after repeated execution of setuptools.
|
|
56
|
+
# > Only files deleted manually within installation folder, are are restored there after repeated execution of setuptools.
|
|
57
|
+
# - No such issues with <Python installation>\Lib\site-packages\<package name>-<versions>.egg-info.
|
|
58
|
+
# - Solution: explicit deletion of all previous output (all documentation-, build- and installation-folder, except the egg-info folder)
|
|
59
|
+
# (see 'delete_previous_build()' and 'delete_previous_installation()')
|
|
60
|
+
#
|
|
61
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
62
|
+
#
|
|
63
|
+
# 24.06.2022
|
|
64
|
+
#
|
|
65
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
66
|
+
|
|
67
|
+
import os, sys, platform, shlex, subprocess
|
|
68
|
+
import setuptools
|
|
69
|
+
from setuptools.command.install import install
|
|
70
|
+
|
|
71
|
+
# prefer the repository local version of all additional libraries (instead of the installed version under site-packages)
|
|
72
|
+
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "./additions")))
|
|
73
|
+
|
|
74
|
+
from config.CRepositoryConfig import CRepositoryConfig # providing repository and environment specific information
|
|
75
|
+
from additions.CExtendedSetup import CExtendedSetup # providing functions to support the extended setup process
|
|
76
|
+
|
|
77
|
+
import colorama as col
|
|
78
|
+
|
|
79
|
+
col.init(autoreset=True)
|
|
80
|
+
|
|
81
|
+
COLBR = col.Style.BRIGHT + col.Fore.RED
|
|
82
|
+
COLBY = col.Style.BRIGHT + col.Fore.YELLOW
|
|
83
|
+
COLBG = col.Style.BRIGHT + col.Fore.GREEN
|
|
84
|
+
|
|
85
|
+
SUCCESS = 0
|
|
86
|
+
ERROR = 1
|
|
87
|
+
|
|
88
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
89
|
+
|
|
90
|
+
def printerror(sMsg):
|
|
91
|
+
sys.stderr.write(COLBR + f"Error: {sMsg}!\n")
|
|
92
|
+
|
|
93
|
+
def printexception(sMsg):
|
|
94
|
+
sys.stderr.write(COLBR + f"Exception: {sMsg}!\n")
|
|
95
|
+
|
|
96
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
97
|
+
|
|
98
|
+
class ExtendedInstallCommand(install):
|
|
99
|
+
"""Extended setup for installation mode."""
|
|
100
|
+
|
|
101
|
+
def run(self):
|
|
102
|
+
|
|
103
|
+
listCmdArgs = sys.argv
|
|
104
|
+
if ( ('install' in listCmdArgs) or ('build' in listCmdArgs) or ('sdist' in listCmdArgs) or ('bdist_wheel' in listCmdArgs) ):
|
|
105
|
+
install.run(self)
|
|
106
|
+
return SUCCESS
|
|
107
|
+
|
|
108
|
+
# eof class ExtendedInstallCommand(install):
|
|
109
|
+
|
|
110
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
111
|
+
|
|
112
|
+
# -- Even in case of other command line parameters than 'install' or 'build' are used we need the following objects.
|
|
113
|
+
# (Without repository configuration commands like '--author-email' would not be possible)
|
|
114
|
+
|
|
115
|
+
# -- setting up the repository configuration
|
|
116
|
+
oRepositoryConfig = None
|
|
117
|
+
try:
|
|
118
|
+
oRepositoryConfig = CRepositoryConfig(os.path.abspath(sys.argv[0]))
|
|
119
|
+
except Exception as ex:
|
|
120
|
+
print()
|
|
121
|
+
printexception(str(ex))
|
|
122
|
+
print()
|
|
123
|
+
sys.exit(ERROR)
|
|
124
|
+
|
|
125
|
+
# -- setting up the extended setup
|
|
126
|
+
oExtendedSetup = None
|
|
127
|
+
try:
|
|
128
|
+
oExtendedSetup = CExtendedSetup(oRepositoryConfig)
|
|
129
|
+
except Exception as ex:
|
|
130
|
+
print()
|
|
131
|
+
printexception(str(ex))
|
|
132
|
+
print()
|
|
133
|
+
sys.exit(ERROR)
|
|
134
|
+
|
|
135
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
136
|
+
|
|
137
|
+
long_description = "long description" # variable is required even in case of other command line parameters than 'install' or 'build' are used
|
|
138
|
+
|
|
139
|
+
listCmdArgs = sys.argv
|
|
140
|
+
if ( ('install' in listCmdArgs) or ('build' in listCmdArgs) or ('sdist' in listCmdArgs) or ('bdist_wheel' in listCmdArgs) ):
|
|
141
|
+
print()
|
|
142
|
+
print(COLBY + "Entering extended installation")
|
|
143
|
+
print()
|
|
144
|
+
|
|
145
|
+
print(COLBY + "Extended setup step 1/5: Calling the documentation builder")
|
|
146
|
+
print()
|
|
147
|
+
|
|
148
|
+
nReturn = oExtendedSetup.genpackagedoc()
|
|
149
|
+
if nReturn != SUCCESS:
|
|
150
|
+
sys.exit(nReturn)
|
|
151
|
+
|
|
152
|
+
print(COLBY + "Extended setup step 2/5: Converting the repository README")
|
|
153
|
+
print()
|
|
154
|
+
|
|
155
|
+
nReturn = oExtendedSetup.convert_repo_readme()
|
|
156
|
+
if nReturn != SUCCESS:
|
|
157
|
+
sys.exit(nReturn)
|
|
158
|
+
|
|
159
|
+
print(COLBY + "Extended setup step 3/5: Deleting previous setup outputs (build, dist, <package name>.egg-info within repository)")
|
|
160
|
+
print()
|
|
161
|
+
|
|
162
|
+
nReturn = oExtendedSetup.delete_previous_build()
|
|
163
|
+
if nReturn != SUCCESS:
|
|
164
|
+
sys.exit(nReturn)
|
|
165
|
+
|
|
166
|
+
if ( ('bdist_wheel' in listCmdArgs) or ('build' in listCmdArgs) ):
|
|
167
|
+
print()
|
|
168
|
+
print(COLBY + "Skipping extended setup step 4/5: Deleting previous package installation folder within site-packages")
|
|
169
|
+
print()
|
|
170
|
+
else:
|
|
171
|
+
print()
|
|
172
|
+
print(COLBY + "Extended setup step 4/5: Deleting previous package installation folder within site-packages") # (<package name> and <package name>_doc under <Python installation>\Lib\site-packages
|
|
173
|
+
print()
|
|
174
|
+
nReturn = oExtendedSetup.delete_previous_installation()
|
|
175
|
+
if nReturn != SUCCESS:
|
|
176
|
+
sys.exit(nReturn)
|
|
177
|
+
|
|
178
|
+
README_MD = str(oRepositoryConfig.Get('README_MD'))
|
|
179
|
+
with open(README_MD, "r", encoding="utf-8") as fh:
|
|
180
|
+
long_description = fh.read()
|
|
181
|
+
fh.close()
|
|
182
|
+
|
|
183
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
184
|
+
|
|
185
|
+
# -- the 'setup' itself
|
|
186
|
+
|
|
187
|
+
print(COLBY + "Extended setup step 5/5: install.run(self)")
|
|
188
|
+
print()
|
|
189
|
+
|
|
190
|
+
setuptools.setup(
|
|
191
|
+
name = str(oRepositoryConfig.Get('REPOSITORYNAME')),
|
|
192
|
+
version = str(oRepositoryConfig.Get('PACKAGEVERSION')),
|
|
193
|
+
author = str(oRepositoryConfig.Get('AUTHOR')),
|
|
194
|
+
author_email = str(oRepositoryConfig.Get('AUTHOREMAIL')),
|
|
195
|
+
description = str(oRepositoryConfig.Get('DESCRIPTION')),
|
|
196
|
+
long_description = long_description,
|
|
197
|
+
long_description_content_type = str(oRepositoryConfig.Get('LONGDESCRIPTIONCONTENTTYPE')),
|
|
198
|
+
url = str(oRepositoryConfig.Get('URL')),
|
|
199
|
+
packages = [str(oRepositoryConfig.Get('PACKAGENAME')),],
|
|
200
|
+
package_dir = {str(oRepositoryConfig.Get('REPOSITORYNAME')) : str(oRepositoryConfig.Get('PACKAGENAME'))},
|
|
201
|
+
classifiers = [
|
|
202
|
+
str(oRepositoryConfig.Get('PROGRAMMINGLANGUAGE')),
|
|
203
|
+
str(oRepositoryConfig.Get('LICENCE')),
|
|
204
|
+
str(oRepositoryConfig.Get('OPERATINGSYSTEM')),
|
|
205
|
+
str(oRepositoryConfig.Get('DEVELOPMENTSTATUS')),
|
|
206
|
+
str(oRepositoryConfig.Get('INTENDEDAUDIENCE')),
|
|
207
|
+
str(oRepositoryConfig.Get('TOPIC')),
|
|
208
|
+
],
|
|
209
|
+
python_requires = str(oRepositoryConfig.Get('PYTHONREQUIRES')),
|
|
210
|
+
cmdclass={
|
|
211
|
+
'install': ExtendedInstallCommand,
|
|
212
|
+
},
|
|
213
|
+
install_requires = oRepositoryConfig.Get('INSTALLREQUIRES'),
|
|
214
|
+
package_data={f"{oRepositoryConfig.Get('PACKAGENAME')}" : oRepositoryConfig.Get('PACKAGEDATA')},
|
|
215
|
+
)
|
|
216
|
+
|
|
217
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
218
|
+
|
|
219
|
+
print()
|
|
220
|
+
print(COLBG + "Extended installation done")
|
|
221
|
+
print()
|
|
222
|
+
|
|
223
|
+
# --------------------------------------------------------------------------------------------------------------
|
|
224
|
+
|