ScriptCollection 4.4.32__py3-none-any.whl → 4.4.34__py3-none-any.whl
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.
- ScriptCollection/ScriptCollectionCore.py +25 -3
- ScriptCollection/TFCPS/TFCPS_Tools_General.py +4 -1
- ScriptCollection/TestKind.py +10 -10
- {scriptcollection-4.4.32.dist-info → scriptcollection-4.4.34.dist-info}/METADATA +169 -169
- {scriptcollection-4.4.32.dist-info → scriptcollection-4.4.34.dist-info}/RECORD +8 -8
- {scriptcollection-4.4.32.dist-info → scriptcollection-4.4.34.dist-info}/WHEEL +0 -0
- {scriptcollection-4.4.32.dist-info → scriptcollection-4.4.34.dist-info}/entry_points.txt +0 -0
- {scriptcollection-4.4.32.dist-info → scriptcollection-4.4.34.dist-info}/top_level.txt +0 -0
|
@@ -40,7 +40,7 @@ from .ProgramRunnerBase import ProgramRunnerBase
|
|
|
40
40
|
from .ProgramRunnerPopen import ProgramRunnerPopen
|
|
41
41
|
from .SCLog import SCLog, LogLevel
|
|
42
42
|
|
|
43
|
-
version = "4.4.
|
|
43
|
+
version = "4.4.34"
|
|
44
44
|
__version__ = version
|
|
45
45
|
|
|
46
46
|
class VSCodeWorkspaceShellTask:
|
|
@@ -4711,13 +4711,35 @@ OCR-content:
|
|
|
4711
4711
|
|
|
4712
4712
|
@GeneralUtilities.check_arguments
|
|
4713
4713
|
def translate_xlf_files_in_folder(self, folder: str, base_language: str, libre_translate_api_server: str):
|
|
4714
|
-
"""Translates all .xlf files directly in the given folder (non-recursive).
|
|
4714
|
+
"""Translates all .xlf files directly in the given folder (non-recursive).
|
|
4715
|
+
|
|
4716
|
+
Only the languages the translation-service really offers are translated. Which languages a project has is
|
|
4717
|
+
its own decision and a LibreTranslate-instance knows a limited set of them, so a project which has one
|
|
4718
|
+
language the instance does not know is the normal case and not a defect - its texts stay untranslated
|
|
4719
|
+
(which is what the fallback to the base-language exists for) and every other language is translated.
|
|
4720
|
+
Without this, the first unknown language would end the whole run with an error and the languages behind it
|
|
4721
|
+
would stay untranslated as well."""
|
|
4715
4722
|
pattern = re.compile(r'^.+\.[a-z]{2,3}\.xlf$')
|
|
4716
|
-
|
|
4723
|
+
supported_languages = self.get_supported_translation_languages(libre_translate_api_server)
|
|
4724
|
+
skipped_languages: list[str] = []
|
|
4725
|
+
for filename in sorted(os.listdir(folder)):
|
|
4717
4726
|
if not pattern.match(filename):
|
|
4718
4727
|
continue
|
|
4728
|
+
language = filename.split(".")[-2]
|
|
4729
|
+
if language not in supported_languages:
|
|
4730
|
+
skipped_languages.append(language)
|
|
4731
|
+
continue
|
|
4719
4732
|
file_path = os.path.join(folder, filename)
|
|
4720
4733
|
self.translate_xlf_file(file_path, base_language, libre_translate_api_server)
|
|
4734
|
+
if 0 < len(skipped_languages):
|
|
4735
|
+
self.log.log(f"The translation-service does not offer these languages, so their texts stay untranslated: {', '.join(skipped_languages)}.", LogLevel.Information)
|
|
4736
|
+
|
|
4737
|
+
@GeneralUtilities.check_arguments
|
|
4738
|
+
def get_supported_translation_languages(self, libre_translate_api_server: str) -> set[str]:
|
|
4739
|
+
"""The languages the LibreTranslate-instance at the given address can translate into."""
|
|
4740
|
+
response = requests.get(f"{libre_translate_api_server.rstrip('/')}/languages", timeout=30)
|
|
4741
|
+
response.raise_for_status()
|
|
4742
|
+
return {language["code"] for language in response.json()}
|
|
4721
4743
|
|
|
4722
4744
|
@GeneralUtilities.check_arguments
|
|
4723
4745
|
def translate_xlf_file(self, file: str, base_language: str, libre_translate_api_server: str):
|
|
@@ -1231,7 +1231,10 @@ class TFCPS_Tools_General:
|
|
|
1231
1231
|
certificate_folder: str = os.path.join(resources_folder, resource_name)
|
|
1232
1232
|
|
|
1233
1233
|
resource_content_filename: str = service_name+resource_name
|
|
1234
|
-
|
|
1234
|
+
#the certificate-files are named after resource_content_filename and not after the domain (see the calls of
|
|
1235
|
+
#generate_certificate and sign_certificate below), so the existence-check has to use that name as well. With the
|
|
1236
|
+
#domain as the name it never found an existing certificate and therefore generated a new one on every run.
|
|
1237
|
+
certificate_file = os.path.join(certificate_folder, f"{resource_content_filename}.crt")
|
|
1235
1238
|
unsignedcertificate_file = os.path.join(certificate_folder, f"{domain}.unsigned.crt")
|
|
1236
1239
|
certificate_exists = os.path.exists(certificate_file)
|
|
1237
1240
|
if certificate_exists:
|
ScriptCollection/TestKind.py
CHANGED
|
@@ -10,20 +10,20 @@ class TestKind(Enum):
|
|
|
10
10
|
# Tests that 2 (or more) components work together like defined.
|
|
11
11
|
IntegrationTest = 1
|
|
12
12
|
|
|
13
|
-
# Tests that are
|
|
13
|
+
# Tests that are not doing anything when committing but can be useful to do or debug a certain task/function.
|
|
14
14
|
DebugHelperTest = 2
|
|
15
15
|
|
|
16
|
-
# Tests that a specific bug does not happen anymore.
|
|
17
|
-
RegressionTest = 3
|
|
18
|
-
|
|
19
16
|
# Tests that other required systems/services used by the function under test are still available and work like specified so that the function under test is able to be working correctly.
|
|
20
|
-
SystemTest =
|
|
17
|
+
SystemTest = 3
|
|
21
18
|
|
|
22
19
|
# Tests that will be done by reflection to assert a certain property for all types or all methods or all attributes in a certain scope.
|
|
23
|
-
ReflectionTest =
|
|
20
|
+
ReflectionTest = 4
|
|
21
|
+
|
|
22
|
+
# Verifies that recent changes did not break anything.
|
|
23
|
+
RegressionTest = 5
|
|
24
24
|
|
|
25
|
-
#
|
|
26
|
-
|
|
25
|
+
# Verifies that recent changes did not change the UI.
|
|
26
|
+
VisualRegressionTest = 6
|
|
27
27
|
|
|
28
28
|
# Tests that verifies a certain performance for a certain operation. Testcases of this kind often require appropriate hardware.
|
|
29
29
|
PerformanceTest = 7
|
|
@@ -31,10 +31,10 @@ class TestKind(Enum):
|
|
|
31
31
|
# Tests that verifies that the entire communication between 2 systems is working correctly including serialization, transport and deserialization.
|
|
32
32
|
EndToEndTest = 8
|
|
33
33
|
|
|
34
|
-
# Test that
|
|
34
|
+
# Test that (re)generates something.
|
|
35
35
|
GenerationTest = 9
|
|
36
36
|
|
|
37
|
-
#
|
|
37
|
+
# Verifies that a certain function is working correctly in a minimal environment with minimal dependencies.
|
|
38
38
|
SmokeTest = 10
|
|
39
39
|
|
|
40
40
|
def __int__(self):
|
|
@@ -1,169 +1,169 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: scriptcollection
|
|
3
|
-
Version: 4.4.
|
|
4
|
-
Summary: The ScriptCollection is the place for reusable scripts.
|
|
5
|
-
Author-email: Marius Göcke <marius.goecke@gmail.com>
|
|
6
|
-
Project-URL: Homepage, https://github.com/anionDev/ScriptCollection
|
|
7
|
-
Project-URL: Documentation, https://aniondev.github.io/ScriptCollectionReference/index.html
|
|
8
|
-
Project-URL: Changelog, https://github.com/anionDev/ScriptCollection/tree/main/Other/Resources/Changelog
|
|
9
|
-
Keywords: package,release,build,management
|
|
10
|
-
Classifier: Intended Audience :: Developers
|
|
11
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
-
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
|
14
|
-
Classifier: Operating System :: POSIX :: Linux
|
|
15
|
-
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
|
|
16
|
-
Classifier: Topic :: System :: Logging
|
|
17
|
-
Classifier: Topic :: System :: Monitoring
|
|
18
|
-
Classifier: Topic :: System :: Archiving :: Packaging
|
|
19
|
-
Classifier: Topic :: System :: Systems Administration
|
|
20
|
-
Classifier: Topic :: Terminals
|
|
21
|
-
Classifier: Topic :: Utilities
|
|
22
|
-
Requires-Python: >=3.11
|
|
23
|
-
Description-Content-Type: text/markdown
|
|
24
|
-
Requires-Dist: build>=1.
|
|
25
|
-
Requires-Dist: CountryInformation>=1.0.12
|
|
26
|
-
Requires-Dist: coverage>=7.
|
|
27
|
-
Requires-Dist: cyclonedx-bom>=7.1.0
|
|
28
|
-
Requires-Dist: defusedxml>=0.7.1
|
|
29
|
-
Requires-Dist: keyboard>=0.13.5
|
|
30
|
-
Requires-Dist: lcov-cobertura>=2.1.1
|
|
31
|
-
Requires-Dist: lxml>=6.0.1
|
|
32
|
-
Requires-Dist: ntplib>=0.4.0
|
|
33
|
-
Requires-Dist: Pillow>=11.3.0
|
|
34
|
-
Requires-Dist: psutil>=7.2.2
|
|
35
|
-
Requires-Dist: pycdlib>=1.
|
|
36
|
-
Requires-Dist: Pygments>=2.
|
|
37
|
-
Requires-Dist: pylint>=4.0.
|
|
38
|
-
Requires-Dist: pyOpenSSL>=25.3.0
|
|
39
|
-
Requires-Dist: PyPDF>=6.
|
|
40
|
-
Requires-Dist: pytest>=8.4.2
|
|
41
|
-
Requires-Dist: PyYAML>=6.0.3
|
|
42
|
-
Requires-Dist: qrcode>=8.2.0
|
|
43
|
-
Requires-Dist: send2trash>=1.8.3
|
|
44
|
-
Requires-Dist: twine>=6.2.0
|
|
45
|
-
Requires-Dist: xmlschema>=4.3.2
|
|
46
|
-
|
|
47
|
-
# ScriptCollection
|
|
48
|
-
|
|
49
|
-
## General
|
|
50
|
-
|
|
51
|
-
[](https://pypi.org/project/ScriptCollection/)
|
|
52
|
-

|
|
53
|
-

|
|
54
|
-
|
|
55
|
-
[](https://www.codefactor.io/repository/github/anionDevevlopment/scriptcollection/overview/main)
|
|
56
|
-
[](https://pepy.tech/project/scriptcollection)
|
|
57
|
-

|
|
58
|
-
|
|
59
|
-
The ScriptCollection is the place for reusable scripts.
|
|
60
|
-
|
|
61
|
-
## Reference
|
|
62
|
-
|
|
63
|
-
The reference can be found [here](https://aniondev.github.io/ScriptCollectionReference/index.html).
|
|
64
|
-
|
|
65
|
-
## Hints
|
|
66
|
-
|
|
67
|
-
Most of the scripts are written in [python](https://www.python.org) 3.
|
|
68
|
-
|
|
69
|
-
Caution: Before executing **any** script of this repository read the sourcecode of the script (and the sourcecode of all functions called by this function directly or transitively) carefully and verify that the script does exactly what you want to do and nothing else.
|
|
70
|
-
|
|
71
|
-
Some functions are not entirely available on windows or require common third-party tools. See the [Runtime dependencies](#runtime-dependencies)-section for more information.
|
|
72
|
-
|
|
73
|
-
When using ScriptCollection it is not required but recommended for better usability to have [epew](https://github.com/anionDev/Epew) installed.
|
|
74
|
-
|
|
75
|
-
## Get ScriptCollection
|
|
76
|
-
|
|
77
|
-
### Installation via pip
|
|
78
|
-
|
|
79
|
-
`pip3 install ScriptCollection`
|
|
80
|
-
|
|
81
|
-
See the [PyPI-site for ScriptCollection](https://pypi.org/project/ScriptCollection)
|
|
82
|
-
|
|
83
|
-
### Download sourcecode using git
|
|
84
|
-
|
|
85
|
-
You can simply git-clone the ScriptCollection and then use the scripts under the provided license.
|
|
86
|
-
|
|
87
|
-
`git clone https://github.com/anionDevevlopment/ScriptCollection.git`
|
|
88
|
-
|
|
89
|
-
It may be more easy to pip-install the ScriptCollection but technically pip is not required. Actually you need to git-clone (or download as zip-file from [GitHub](https://github.com/anionDevevlopment/ScriptCollection) the ScriptCollection to use the scripts in this repository which are not written in python.
|
|
90
|
-
|
|
91
|
-
## Troubleshooting
|
|
92
|
-
|
|
93
|
-
It is recommended to always use only the newest version of the ScriptCollection. If you have an older version: Update it (e. g. using `pip3 install ScriptCollection --upgrade` if you installed the ScriptCollection via pip). If you still have problems, then feel free to create an [issue](https://github.com/anionDevevlopment/ScriptCollection/issues).
|
|
94
|
-
|
|
95
|
-
If you have installed the ScriptCollection as pip-package you can simply check the version using Python with the following commands:
|
|
96
|
-
|
|
97
|
-
```lang-bash
|
|
98
|
-
from ScriptCollection.ScriptCollectionCore import ScriptCollectionCore
|
|
99
|
-
ScriptCollectionCore.get_scriptcollection_version()
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
Or you can simply run `pip3 freeze` folder to get information about (all) currently installed pip-packages.
|
|
103
|
-
|
|
104
|
-
## Development
|
|
105
|
-
|
|
106
|
-
### Branching-system
|
|
107
|
-
|
|
108
|
-
This repository applies the [GitFlowSimplified](https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/blob/main/Conventions/BranchingSystem/GitFlowSimplified/GitFlowSimplified.md)-branching-system.
|
|
109
|
-
|
|
110
|
-
### Repository-structure
|
|
111
|
-
|
|
112
|
-
This repository applies the [CommonProjectStructure](https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/blob/main/Conventions/RepositoryStructure/CommonProjectStructure/CommonProjectStructure.md)-branching-system.
|
|
113
|
-
|
|
114
|
-
### Install dependencies
|
|
115
|
-
|
|
116
|
-
ScriptCollection requires [Python](https://www.python.org) 3.10.
|
|
117
|
-
|
|
118
|
-
To develop ScriptCollection it is obviously required that the following commandline-commands are available on your system:
|
|
119
|
-
|
|
120
|
-
- `python` (on some systems `python3`)
|
|
121
|
-
- `pip3`
|
|
122
|
-
|
|
123
|
-
The pip-packages which are required for developing on this project are defined in `requirements.txt`.
|
|
124
|
-
|
|
125
|
-
### IDE
|
|
126
|
-
|
|
127
|
-
The recommended IDE for developing ScriptCollection is Visual Studio Code.
|
|
128
|
-
The recommended addons for developing ScriptCollection with Visual Studio Code are:
|
|
129
|
-
|
|
130
|
-
- [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
|
|
131
|
-
- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
|
|
132
|
-
- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
|
|
133
|
-
- [docs-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown)
|
|
134
|
-
|
|
135
|
-
### Build
|
|
136
|
-
|
|
137
|
-
To create and install an ScriptCollection locally simply do the following commands:
|
|
138
|
-
|
|
139
|
-
```bash
|
|
140
|
-
python ./ScriptCollection/Other/Build/Build.py
|
|
141
|
-
pip3 install --force-reinstall ./ScriptCollection/Other/Artifacts/Wheel/ScriptCollection-x.x.x-py3-none-any.whl
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
(Note: `x.x.x` must be replaced by the appropriate version-number.)
|
|
145
|
-
|
|
146
|
-
### Coding style
|
|
147
|
-
|
|
148
|
-
In this repository [pylint](https://pylint.org/) will be used to report linting-issues.
|
|
149
|
-
If you change code in this repository please ensure pylint does not find any issues before creating a pull-request.
|
|
150
|
-
|
|
151
|
-
If linting-issues exist in the current code-base can be checked by running `python ./ScriptCollection/Other/QualityCheck/Linting.py`.
|
|
152
|
-
|
|
153
|
-
## Runtime dependencies
|
|
154
|
-
|
|
155
|
-
ScriptCollection requires [Python](https://www.python.org) 3.10.
|
|
156
|
-
|
|
157
|
-
The usual Python-dependencies will be installed automagically by `pip`.
|
|
158
|
-
|
|
159
|
-
For functions to to read or change the permissions or the owner of a file the ScriptCollection relies on the functionality of the following tools:
|
|
160
|
-
|
|
161
|
-
- chmod
|
|
162
|
-
- chown
|
|
163
|
-
- ls
|
|
164
|
-
|
|
165
|
-
This tools must be available on the system where the functions should be executed. Meanwhile this tools are also available on Windows but may have a slightly limited functionality.
|
|
166
|
-
|
|
167
|
-
## License
|
|
168
|
-
|
|
169
|
-
See [License.txt](https://raw.githubusercontent.com/anionDevevlopment/ScriptCollection/main/License.txt) for license-information.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: scriptcollection
|
|
3
|
+
Version: 4.4.34
|
|
4
|
+
Summary: The ScriptCollection is the place for reusable scripts.
|
|
5
|
+
Author-email: Marius Göcke <marius.goecke@gmail.com>
|
|
6
|
+
Project-URL: Homepage, https://github.com/anionDev/ScriptCollection
|
|
7
|
+
Project-URL: Documentation, https://aniondev.github.io/ScriptCollectionReference/index.html
|
|
8
|
+
Project-URL: Changelog, https://github.com/anionDev/ScriptCollection/tree/main/Other/Resources/Changelog
|
|
9
|
+
Keywords: package,release,build,management
|
|
10
|
+
Classifier: Intended Audience :: Developers
|
|
11
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
|
14
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
15
|
+
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
|
|
16
|
+
Classifier: Topic :: System :: Logging
|
|
17
|
+
Classifier: Topic :: System :: Monitoring
|
|
18
|
+
Classifier: Topic :: System :: Archiving :: Packaging
|
|
19
|
+
Classifier: Topic :: System :: Systems Administration
|
|
20
|
+
Classifier: Topic :: Terminals
|
|
21
|
+
Classifier: Topic :: Utilities
|
|
22
|
+
Requires-Python: >=3.11
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
Requires-Dist: build>=1.6.1
|
|
25
|
+
Requires-Dist: CountryInformation>=1.0.12
|
|
26
|
+
Requires-Dist: coverage>=7.16.1
|
|
27
|
+
Requires-Dist: cyclonedx-bom>=7.1.0
|
|
28
|
+
Requires-Dist: defusedxml>=0.7.1
|
|
29
|
+
Requires-Dist: keyboard>=0.13.5
|
|
30
|
+
Requires-Dist: lcov-cobertura>=2.1.1
|
|
31
|
+
Requires-Dist: lxml>=6.0.1
|
|
32
|
+
Requires-Dist: ntplib>=0.4.0
|
|
33
|
+
Requires-Dist: Pillow>=11.3.0
|
|
34
|
+
Requires-Dist: psutil>=7.2.2
|
|
35
|
+
Requires-Dist: pycdlib>=1.20.0
|
|
36
|
+
Requires-Dist: Pygments>=2.21.0
|
|
37
|
+
Requires-Dist: pylint>=4.0.8
|
|
38
|
+
Requires-Dist: pyOpenSSL>=25.3.0
|
|
39
|
+
Requires-Dist: PyPDF>=6.19.0
|
|
40
|
+
Requires-Dist: pytest>=8.4.2
|
|
41
|
+
Requires-Dist: PyYAML>=6.0.3
|
|
42
|
+
Requires-Dist: qrcode>=8.2.0
|
|
43
|
+
Requires-Dist: send2trash>=1.8.3
|
|
44
|
+
Requires-Dist: twine>=6.2.0
|
|
45
|
+
Requires-Dist: xmlschema>=4.3.2
|
|
46
|
+
|
|
47
|
+
# ScriptCollection
|
|
48
|
+
|
|
49
|
+
## General
|
|
50
|
+
|
|
51
|
+
[](https://pypi.org/project/ScriptCollection/)
|
|
52
|
+

|
|
53
|
+

|
|
54
|
+
|
|
55
|
+
[](https://www.codefactor.io/repository/github/anionDevevlopment/scriptcollection/overview/main)
|
|
56
|
+
[](https://pepy.tech/project/scriptcollection)
|
|
57
|
+

|
|
58
|
+
|
|
59
|
+
The ScriptCollection is the place for reusable scripts.
|
|
60
|
+
|
|
61
|
+
## Reference
|
|
62
|
+
|
|
63
|
+
The reference can be found [here](https://aniondev.github.io/ScriptCollectionReference/index.html).
|
|
64
|
+
|
|
65
|
+
## Hints
|
|
66
|
+
|
|
67
|
+
Most of the scripts are written in [python](https://www.python.org) 3.
|
|
68
|
+
|
|
69
|
+
Caution: Before executing **any** script of this repository read the sourcecode of the script (and the sourcecode of all functions called by this function directly or transitively) carefully and verify that the script does exactly what you want to do and nothing else.
|
|
70
|
+
|
|
71
|
+
Some functions are not entirely available on windows or require common third-party tools. See the [Runtime dependencies](#runtime-dependencies)-section for more information.
|
|
72
|
+
|
|
73
|
+
When using ScriptCollection it is not required but recommended for better usability to have [epew](https://github.com/anionDev/Epew) installed.
|
|
74
|
+
|
|
75
|
+
## Get ScriptCollection
|
|
76
|
+
|
|
77
|
+
### Installation via pip
|
|
78
|
+
|
|
79
|
+
`pip3 install ScriptCollection`
|
|
80
|
+
|
|
81
|
+
See the [PyPI-site for ScriptCollection](https://pypi.org/project/ScriptCollection)
|
|
82
|
+
|
|
83
|
+
### Download sourcecode using git
|
|
84
|
+
|
|
85
|
+
You can simply git-clone the ScriptCollection and then use the scripts under the provided license.
|
|
86
|
+
|
|
87
|
+
`git clone https://github.com/anionDevevlopment/ScriptCollection.git`
|
|
88
|
+
|
|
89
|
+
It may be more easy to pip-install the ScriptCollection but technically pip is not required. Actually you need to git-clone (or download as zip-file from [GitHub](https://github.com/anionDevevlopment/ScriptCollection) the ScriptCollection to use the scripts in this repository which are not written in python.
|
|
90
|
+
|
|
91
|
+
## Troubleshooting
|
|
92
|
+
|
|
93
|
+
It is recommended to always use only the newest version of the ScriptCollection. If you have an older version: Update it (e. g. using `pip3 install ScriptCollection --upgrade` if you installed the ScriptCollection via pip). If you still have problems, then feel free to create an [issue](https://github.com/anionDevevlopment/ScriptCollection/issues).
|
|
94
|
+
|
|
95
|
+
If you have installed the ScriptCollection as pip-package you can simply check the version using Python with the following commands:
|
|
96
|
+
|
|
97
|
+
```lang-bash
|
|
98
|
+
from ScriptCollection.ScriptCollectionCore import ScriptCollectionCore
|
|
99
|
+
ScriptCollectionCore.get_scriptcollection_version()
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Or you can simply run `pip3 freeze` folder to get information about (all) currently installed pip-packages.
|
|
103
|
+
|
|
104
|
+
## Development
|
|
105
|
+
|
|
106
|
+
### Branching-system
|
|
107
|
+
|
|
108
|
+
This repository applies the [GitFlowSimplified](https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/blob/main/Conventions/BranchingSystem/GitFlowSimplified/GitFlowSimplified.md)-branching-system.
|
|
109
|
+
|
|
110
|
+
### Repository-structure
|
|
111
|
+
|
|
112
|
+
This repository applies the [CommonProjectStructure](https://projects.aniondev.de/PublicProjects/Common/ProjectTemplates/-/blob/main/Conventions/RepositoryStructure/CommonProjectStructure/CommonProjectStructure.md)-branching-system.
|
|
113
|
+
|
|
114
|
+
### Install dependencies
|
|
115
|
+
|
|
116
|
+
ScriptCollection requires [Python](https://www.python.org) 3.10.
|
|
117
|
+
|
|
118
|
+
To develop ScriptCollection it is obviously required that the following commandline-commands are available on your system:
|
|
119
|
+
|
|
120
|
+
- `python` (on some systems `python3`)
|
|
121
|
+
- `pip3`
|
|
122
|
+
|
|
123
|
+
The pip-packages which are required for developing on this project are defined in `requirements.txt`.
|
|
124
|
+
|
|
125
|
+
### IDE
|
|
126
|
+
|
|
127
|
+
The recommended IDE for developing ScriptCollection is Visual Studio Code.
|
|
128
|
+
The recommended addons for developing ScriptCollection with Visual Studio Code are:
|
|
129
|
+
|
|
130
|
+
- [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
|
|
131
|
+
- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
|
|
132
|
+
- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
|
|
133
|
+
- [docs-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown)
|
|
134
|
+
|
|
135
|
+
### Build
|
|
136
|
+
|
|
137
|
+
To create and install an ScriptCollection locally simply do the following commands:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
python ./ScriptCollection/Other/Build/Build.py
|
|
141
|
+
pip3 install --force-reinstall ./ScriptCollection/Other/Artifacts/Wheel/ScriptCollection-x.x.x-py3-none-any.whl
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
(Note: `x.x.x` must be replaced by the appropriate version-number.)
|
|
145
|
+
|
|
146
|
+
### Coding style
|
|
147
|
+
|
|
148
|
+
In this repository [pylint](https://pylint.org/) will be used to report linting-issues.
|
|
149
|
+
If you change code in this repository please ensure pylint does not find any issues before creating a pull-request.
|
|
150
|
+
|
|
151
|
+
If linting-issues exist in the current code-base can be checked by running `python ./ScriptCollection/Other/QualityCheck/Linting.py`.
|
|
152
|
+
|
|
153
|
+
## Runtime dependencies
|
|
154
|
+
|
|
155
|
+
ScriptCollection requires [Python](https://www.python.org) 3.10.
|
|
156
|
+
|
|
157
|
+
The usual Python-dependencies will be installed automagically by `pip`.
|
|
158
|
+
|
|
159
|
+
For functions to to read or change the permissions or the owner of a file the ScriptCollection relies on the functionality of the following tools:
|
|
160
|
+
|
|
161
|
+
- chmod
|
|
162
|
+
- chown
|
|
163
|
+
- ls
|
|
164
|
+
|
|
165
|
+
This tools must be available on the system where the functions should be executed. Meanwhile this tools are also available on Windows but may have a slightly limited functionality.
|
|
166
|
+
|
|
167
|
+
## License
|
|
168
|
+
|
|
169
|
+
See [License.txt](https://raw.githubusercontent.com/anionDevevlopment/ScriptCollection/main/License.txt) for license-information.
|
|
@@ -12,8 +12,8 @@ ScriptCollection/ProgramRunnerSudo.py,sha256=ot9Ib-plQ8wejR9M2XXfnx6GR-va9k8SH1g
|
|
|
12
12
|
ScriptCollection/RepositoryDiagramGenerator.py,sha256=K_u2NW_p4ozdWD50irJEkkcDVa70TcUJpZN63TeXSLw,7092
|
|
13
13
|
ScriptCollection/RepositoryHistoryAnalyzer.py,sha256=rD8eC5lMUe5MHmCBHfYft_G-N9IbvtsFGkU7EMwPjrY,5779
|
|
14
14
|
ScriptCollection/SCLog.py,sha256=Fjf8Pdi63cXHGMxL_aI6A0dwGm7QIfrv3czjvpSUlaM,4705
|
|
15
|
-
ScriptCollection/ScriptCollectionCore.py,sha256=
|
|
16
|
-
ScriptCollection/TestKind.py,sha256=
|
|
15
|
+
ScriptCollection/ScriptCollectionCore.py,sha256=mF9RaztIjkwVdxOI9HSX7X1AASl-0FuHYoTHG3wzy4c,300265
|
|
16
|
+
ScriptCollection/TestKind.py,sha256=jqLJwNvQeyea7SZf-UFzMC9pM0znv4do7FIC1xq8u9M,1672
|
|
17
17
|
ScriptCollection/UnassignedVariablesCheck.py,sha256=8xNcp1D5HeOLO1a1NEerq2TsnpFhw7yzYPkaay-oisY,3804
|
|
18
18
|
ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
19
19
|
ScriptCollection/OCIImages/AbstractImageHandler.py,sha256=UB0lUYdAjFk8RIgsikKELRWDMZPlR_zNgwvCJS1naVs,2455
|
|
@@ -45,7 +45,7 @@ ScriptCollection/TFCPS/TFCPS_MergeToStable.py,sha256=oYEhz5ZWMnbu97_CcYEqdDxakUF
|
|
|
45
45
|
ScriptCollection/TFCPS/TFCPS_OCIImageSecretScan.py,sha256=rhw0glr4gZ5enG9faOD51xE4MMK1cIdNjUdaswiMsrY,14622
|
|
46
46
|
ScriptCollection/TFCPS/TFCPS_PreBuildCodeunitsScript.py,sha256=XLVsFTA1jvfDbZ7wYJgIdEByZhF_bYVbA5jkisuvK4k,2322
|
|
47
47
|
ScriptCollection/TFCPS/TFCPS_RemoteBuild.py,sha256=2Tx5HLk1ZftBWDCTiGZdP2QiiGNyWsEuTCSt33dNQjc,23891
|
|
48
|
-
ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=
|
|
48
|
+
ScriptCollection/TFCPS/TFCPS_Tools_General.py,sha256=d_gCL3ExRoNgerQwEzc2qoY6wG3ZEUqw-ZT6Xb6C_xs,157127
|
|
49
49
|
ScriptCollection/TFCPS/TFCPS_VisualRegressionTests.py,sha256=6_63udxHnPlu_TMk_ftLZTnzriJO8MCxVCVAsweZqHs,37073
|
|
50
50
|
ScriptCollection/TFCPS/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
51
51
|
ScriptCollection/TFCPS/CPP/TFCPS_CodeUnitSpecific_CPP.py,sha256=BNZPMjGiWLMBH7QDtP06WEVLMnI38NLX4Dpd13bSbi4,16614
|
|
@@ -71,8 +71,8 @@ ScriptCollection/TFCPS/Rust/TFCPS_CodeUnitSpecific_Rust.py,sha256=yyjWPMHQjPLkML
|
|
|
71
71
|
ScriptCollection/TFCPS/Rust/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
72
72
|
ScriptCollection/TFCPS/TypeScript/TFCPS_CodeUnitSpecific_TypeScript.py,sha256=5z990qyO5durX07xRWRwju1hl6wpjQAy2f-yRwJ-7s0,11856
|
|
73
73
|
ScriptCollection/TFCPS/TypeScript/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
74
|
-
scriptcollection-4.4.
|
|
75
|
-
scriptcollection-4.4.
|
|
76
|
-
scriptcollection-4.4.
|
|
77
|
-
scriptcollection-4.4.
|
|
78
|
-
scriptcollection-4.4.
|
|
74
|
+
scriptcollection-4.4.34.dist-info/METADATA,sha256=p-aTah6OXjQNU4qQFArPBUp29BLm2M2vKDZcXhDyy6M,7690
|
|
75
|
+
scriptcollection-4.4.34.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
|
|
76
|
+
scriptcollection-4.4.34.dist-info/entry_points.txt,sha256=GNma7tN0J59EvK71su-G1w22RnZ05bXcPrELyLx3AL0,6151
|
|
77
|
+
scriptcollection-4.4.34.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
|
|
78
|
+
scriptcollection-4.4.34.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|