ScriptCollection 4.4.40__py3-none-any.whl → 4.4.41__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 +1 -12
- ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py +15 -6
- ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py +39 -1
- {scriptcollection-4.4.40.dist-info → scriptcollection-4.4.41.dist-info}/METADATA +169 -169
- {scriptcollection-4.4.40.dist-info → scriptcollection-4.4.41.dist-info}/RECORD +8 -8
- {scriptcollection-4.4.40.dist-info → scriptcollection-4.4.41.dist-info}/WHEEL +0 -0
- {scriptcollection-4.4.40.dist-info → scriptcollection-4.4.41.dist-info}/entry_points.txt +0 -0
- {scriptcollection-4.4.40.dist-info → scriptcollection-4.4.41.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.41"
|
|
44
44
|
__version__ = version
|
|
45
45
|
|
|
46
46
|
class VSCodeWorkspaceShellTask:
|
|
@@ -2999,17 +2999,6 @@ resolving a name requires fontconfig, which does not exist on every system ffmpe
|
|
|
2999
2999
|
def get_scriptcollection_repository_cache_folder(self, repository_folder: str) -> str:
|
|
3000
3000
|
return os.path.join(repository_folder, ".ScriptCollection", "Cache")
|
|
3001
3001
|
|
|
3002
|
-
@GeneralUtilities.check_arguments
|
|
3003
|
-
def ensure_scriptcollection_gitignore_is_setup(self, repository_folder: str) -> None:
|
|
3004
|
-
"""Ensures that "<repository>/.ScriptCollection/.gitignore" exists and contains the expected entries."""
|
|
3005
|
-
scriptcollection_folder = os.path.join(repository_folder, ".ScriptCollection")
|
|
3006
|
-
GeneralUtilities.ensure_directory_exists(scriptcollection_folder)
|
|
3007
|
-
gitignore_file = os.path.join(scriptcollection_folder, ".gitignore")
|
|
3008
|
-
lines = [
|
|
3009
|
-
"/Cache/",
|
|
3010
|
-
]
|
|
3011
|
-
GeneralUtilities.write_lines_to_file(gitignore_file, lines)
|
|
3012
|
-
|
|
3013
3002
|
@GeneralUtilities.check_arguments
|
|
3014
3003
|
def ensure_line_is_in_gitignore(self, repository_folder: str, line: str) -> None:
|
|
3015
3004
|
"""Ensures that "<repository>/.gitignore" exists and contains the given line. The line is appended if it is not contained yet."""
|
|
@@ -565,6 +565,7 @@ class TFCPS_CodeUnitSpecific_DotNet_Functions(TFCPS_CodeUnitSpecific_Base):
|
|
|
565
565
|
<PreserveCompilationContext>false<\\/PreserveCompilationContext>
|
|
566
566
|
<GenerateRuntimeConfigurationFiles>true<\\/GenerateRuntimeConfigurationFiles>
|
|
567
567
|
<RestorePackagesWithLockFile>true<\\/RestorePackagesWithLockFile>
|
|
568
|
+
<NuGetAuditMode>all<\\/NuGetAuditMode>
|
|
568
569
|
<Copyright>([^<]+)<\\/Copyright>
|
|
569
570
|
<Description>{codeunit_description_regex}<\\/Description>
|
|
570
571
|
<PackageProjectUrl>https:\\/\\/([^<]+)<\\/PackageProjectUrl>
|
|
@@ -632,6 +633,7 @@ class TFCPS_CodeUnitSpecific_DotNet_Functions(TFCPS_CodeUnitSpecific_Base):
|
|
|
632
633
|
<PreserveCompilationContext>false<\\/PreserveCompilationContext>
|
|
633
634
|
<GenerateRuntimeConfigurationFiles>true<\\/GenerateRuntimeConfigurationFiles>
|
|
634
635
|
<RestorePackagesWithLockFile>true<\\/RestorePackagesWithLockFile>
|
|
636
|
+
<NuGetAuditMode>all<\\/NuGetAuditMode>
|
|
635
637
|
<Copyright>([^<]+)<\\/Copyright>
|
|
636
638
|
<Description>{codeunit_name_regex}Tests is the test-project for {codeunit_name_regex}\\.<\\/Description>
|
|
637
639
|
<PackageProjectUrl>https:\\/\\/([^<]+)<\\/PackageProjectUrl>
|
|
@@ -783,12 +785,19 @@ class TFCPS_CodeUnitSpecific_DotNet_Functions(TFCPS_CodeUnitSpecific_Base):
|
|
|
783
785
|
|
|
784
786
|
self.__remove_unrelated_package_from_testcoverage_file(target_file, codeunit_name)
|
|
785
787
|
root: etree._ElementTree = etree.parse(target_file)
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
788
|
+
source_paths_in_coverage_file: list = root.xpath("//coverage/sources/source/text()")
|
|
789
|
+
if len(source_paths_in_coverage_file) == 0:
|
|
790
|
+
# The coverage-report does not contain any source-entry. This happens when the collector produced an empty
|
|
791
|
+
# report (for example when no assembly was instrumented). There are then no filename-attributes which point
|
|
792
|
+
# into the source-tree, so the path-rewriting below is skipped instead of failing with an index-error.
|
|
793
|
+
self._protected_sc.log.log(f"The test-coverage-report \"{target_file}\" does not contain any source-entry, so no coverage seems to have been collected for codeunit \"{codeunit_name}\". The coverage-paths are therefore not rewritten.", LogLevel.Warning)
|
|
794
|
+
else:
|
|
795
|
+
source_base_path_in_coverage_file: str = source_paths_in_coverage_file[0].replace("\\", "/")
|
|
796
|
+
content = GeneralUtilities.read_text_from_file(target_file)
|
|
797
|
+
GeneralUtilities.assert_condition(source_base_path_in_coverage_file.startswith(repository_folder) or repository_folder.startswith(source_base_path_in_coverage_file), f"Unexpected path for coverage. Sourcepath: \"{source_base_path_in_coverage_file}\"; repository: \"{repository_folder}\"")
|
|
798
|
+
content = re.sub('\\\\', '/', content)
|
|
799
|
+
content = re.sub("filename=\"([^\"]+)\"", lambda match: self.__standardized_tasks_run_testcases_for_dotnet_project_helper(source_base_path_in_coverage_file, codeunit_folder, match), content)
|
|
800
|
+
GeneralUtilities.write_text_to_file(target_file, content)
|
|
792
801
|
self.run_testcases_common_post_task(repository_folder, codeunit_name, True, self.get_target_environment_type())
|
|
793
802
|
artifacts_folder = os.path.join(repository_folder, codeunit_name, "Other", "Artifacts")
|
|
794
803
|
for subfolder in GeneralUtilities.get_direct_folders_of_folder(artifacts_folder):
|
|
@@ -130,7 +130,13 @@ class TFCPS_CodeUnit_BuildCodeUnits:
|
|
|
130
130
|
self.sc.ensure_line_is_in_gitignore(self.repository, "Other/Resources/Artifacts")
|
|
131
131
|
|
|
132
132
|
#ensure <repo>/.ScriptCollection/.gitignore is set up (ignores the cache-folder so cache-files never show up as uncommitted changes)
|
|
133
|
-
self.
|
|
133
|
+
self.__ensure_scriptcollection_gitignore_is_setup(self.repository)
|
|
134
|
+
|
|
135
|
+
#ensure <repo>/.gitignore is set up (ignores the cache-folder so cache-files never show up as uncommitted changes)
|
|
136
|
+
self.__ensure_global_gitignore_is_setup(self.repository)
|
|
137
|
+
|
|
138
|
+
#validate the openspec-specifications if openspec is set up in the repository
|
|
139
|
+
self.__validate_openspec()
|
|
134
140
|
|
|
135
141
|
self.sc.log.log(f"Start building codeunits at {GeneralUtilities.datetime_to_string_for_readable_entry(start_time,False)}. (Target environment-type: {self.target_environment_type})")
|
|
136
142
|
|
|
@@ -143,6 +149,9 @@ class TFCPS_CodeUnit_BuildCodeUnits:
|
|
|
143
149
|
git_commit_message_cache_file=os.path.join(cache_folder,"GitCommitDescriptionDraft.txt")
|
|
144
150
|
GeneralUtilities.ensure_file_exists(git_commit_message_cache_file)
|
|
145
151
|
|
|
152
|
+
notes_folder=os.path.join(self.repository,".notes")
|
|
153
|
+
GeneralUtilities.ensure_directory_exists(notes_folder)
|
|
154
|
+
|
|
146
155
|
self.tfcps_tools_general.ensure_required_environment_variables_are_set(self.repository)
|
|
147
156
|
|
|
148
157
|
self.__run_custom_pre_codeunit_build_script()
|
|
@@ -225,6 +234,28 @@ class TFCPS_CodeUnit_BuildCodeUnits:
|
|
|
225
234
|
self.sc.log.log(f"Finished building codeunits at {GeneralUtilities.datetime_to_string_for_readable_entry(end_time,False)}. (Duration: {GeneralUtilities.timedelta_to_simple_string(duration)})")
|
|
226
235
|
self.sc.log.log(GeneralUtilities.get_line())
|
|
227
236
|
|
|
237
|
+
|
|
238
|
+
@GeneralUtilities.check_arguments
|
|
239
|
+
def __ensure_scriptcollection_gitignore_is_setup(self, repository_folder: str) -> None:
|
|
240
|
+
"""Ensures that "<repository>/.ScriptCollection/.gitignore" exists and contains the expected entries."""
|
|
241
|
+
scriptcollection_folder = os.path.join(repository_folder, ".ScriptCollection")
|
|
242
|
+
GeneralUtilities.ensure_directory_exists(scriptcollection_folder)
|
|
243
|
+
gitignore_file = os.path.join(scriptcollection_folder, ".gitignore")
|
|
244
|
+
lines = [
|
|
245
|
+
"/Cache/",
|
|
246
|
+
]
|
|
247
|
+
GeneralUtilities.write_lines_to_file(gitignore_file, lines)
|
|
248
|
+
|
|
249
|
+
@GeneralUtilities.check_arguments
|
|
250
|
+
def __ensure_global_gitignore_is_setup(self, repository_folder: str) -> None:
|
|
251
|
+
"""Ensures that "<repository>/.gitignore" exists and contains the expected entries."""
|
|
252
|
+
gitignore_file = os.path.join(repository_folder, ".gitignore")
|
|
253
|
+
lines = [
|
|
254
|
+
"/.notes/",
|
|
255
|
+
]
|
|
256
|
+
GeneralUtilities.write_lines_to_file(gitignore_file, lines)
|
|
257
|
+
|
|
258
|
+
|
|
228
259
|
@GeneralUtilities.check_arguments
|
|
229
260
|
def __create_artifacts_archive(self, codeunits:list[str]) -> str:
|
|
230
261
|
product_name:str=self.tfcps_tools_general.get_product_name(self.repository)
|
|
@@ -330,6 +361,13 @@ class TFCPS_CodeUnit_BuildCodeUnits:
|
|
|
330
361
|
self.sc.log.log("Update openspec-instruction-files...")
|
|
331
362
|
self.sc.run_with_epew("openspec", "update --force", self.repository)
|
|
332
363
|
|
|
364
|
+
@GeneralUtilities.check_arguments
|
|
365
|
+
def __validate_openspec(self) -> None:
|
|
366
|
+
openspec_configuration_file: str = os.path.join(self.repository, "openspec", "config.yaml")
|
|
367
|
+
if os.path.isfile(openspec_configuration_file):
|
|
368
|
+
self.sc.log.log("Validate openspec-specifications...")
|
|
369
|
+
self.sc.run_with_epew("openspec", "validate --all --strict", self.repository)
|
|
370
|
+
|
|
333
371
|
@GeneralUtilities.check_arguments
|
|
334
372
|
def build_codeunits_in_container(self,base_mount_folder:str) -> tuple[bool, str]:
|
|
335
373
|
container_base_mount_folder, container_repository_folder = self.__get_folders_inside_container(base_mount_folder)
|
|
@@ -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
|
-
License-Expression: GPL-3.0-only
|
|
7
|
-
Project-URL: Homepage, https://github.com/anionDev/ScriptCollection
|
|
8
|
-
Project-URL: Documentation, https://aniondev.github.io/ScriptCollectionReference/index.html
|
|
9
|
-
Project-URL: Changelog, https://github.com/anionDev/ScriptCollection/tree/main/Other/Resources/Changelog
|
|
10
|
-
Keywords: package,release,build,management
|
|
11
|
-
Classifier: Intended Audience :: Developers
|
|
12
|
-
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
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.9
|
|
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.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: scriptcollection
|
|
3
|
+
Version: 4.4.41
|
|
4
|
+
Summary: The ScriptCollection is the place for reusable scripts.
|
|
5
|
+
Author-email: Marius Göcke <marius.goecke@gmail.com>
|
|
6
|
+
License-Expression: GPL-3.0-only
|
|
7
|
+
Project-URL: Homepage, https://github.com/anionDev/ScriptCollection
|
|
8
|
+
Project-URL: Documentation, https://aniondev.github.io/ScriptCollectionReference/index.html
|
|
9
|
+
Project-URL: Changelog, https://github.com/anionDev/ScriptCollection/tree/main/Other/Resources/Changelog
|
|
10
|
+
Keywords: package,release,build,management
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
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.9
|
|
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.
|
|
@@ -11,7 +11,7 @@ ScriptCollection/ProgramRunnerSudo.py,sha256=ot9Ib-plQ8wejR9M2XXfnx6GR-va9k8SH1g
|
|
|
11
11
|
ScriptCollection/RepositoryDiagramGenerator.py,sha256=K_u2NW_p4ozdWD50irJEkkcDVa70TcUJpZN63TeXSLw,7092
|
|
12
12
|
ScriptCollection/RepositoryHistoryAnalyzer.py,sha256=rD8eC5lMUe5MHmCBHfYft_G-N9IbvtsFGkU7EMwPjrY,5779
|
|
13
13
|
ScriptCollection/SCLog.py,sha256=Fjf8Pdi63cXHGMxL_aI6A0dwGm7QIfrv3czjvpSUlaM,4705
|
|
14
|
-
ScriptCollection/ScriptCollectionCore.py,sha256=
|
|
14
|
+
ScriptCollection/ScriptCollectionCore.py,sha256=azPvrjlx08-4xtMchrttbSTjMHYU2kXuprPsqBn8U4w,304508
|
|
15
15
|
ScriptCollection/TestKind.py,sha256=jqLJwNvQeyea7SZf-UFzMC9pM0znv4do7FIC1xq8u9M,1672
|
|
16
16
|
ScriptCollection/UnassignedVariablesCheck.py,sha256=8xNcp1D5HeOLO1a1NEerq2TsnpFhw7yzYPkaay-oisY,3804
|
|
17
17
|
ScriptCollection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
@@ -38,7 +38,7 @@ ScriptCollection/TFCPS/SCTaskRunnerServer.py,sha256=tub8_1QBu0nWAaGnBWp2nErOW-SO
|
|
|
38
38
|
ScriptCollection/TFCPS/TFCPS_BuildCodeUnitsHook.py,sha256=67_DQwoH5bhxxSmwtuAeoW1NOCMiLMzOy48OqlJX-KY,1744
|
|
39
39
|
ScriptCollection/TFCPS/TFCPS_CodeUnitSpecific_Base.py,sha256=umUfQDErp7xFLkDnSbQMxzUWnKtcGlrZnIvFcTpfGJs,40499
|
|
40
40
|
ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnit.py,sha256=Mj9t1SyRpkYZE74cLsGWYv4xB89gXL2ld-RX3xvvGdw,9835
|
|
41
|
-
ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py,sha256=
|
|
41
|
+
ScriptCollection/TFCPS/TFCPS_CodeUnit_BuildCodeUnits.py,sha256=oTOEziFGpwVip5CwIKovoEErpRBGhaQPhBSEbBWgnfk,52521
|
|
42
42
|
ScriptCollection/TFCPS/TFCPS_CreateRelease.py,sha256=kpEmSnfzfgB4OjcCuS_X6jgW_ftcphxEnjjoLoAHTLY,6582
|
|
43
43
|
ScriptCollection/TFCPS/TFCPS_Generic.py,sha256=mRBcf7XuNWOSXbZYc3NuJow18AMZ30D6Z-BtyNYfNcM,2072
|
|
44
44
|
ScriptCollection/TFCPS/TFCPS_MergeToMain.py,sha256=Krt5oyGNcRAN3szsgU7LoTh8yVTOdHW-Kq7R9MDDV-Q,7673
|
|
@@ -56,7 +56,7 @@ ScriptCollection/TFCPS/Docker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5N
|
|
|
56
56
|
ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationBase.py,sha256=bT6Gd5pQpZCw4OQz6HWkPCSn5z__eUUEisABLDSxd0o,200
|
|
57
57
|
ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationGenerate.py,sha256=QyjOfMY22JWCvKjMelHiDWbJiWqotOfebpJpgDUaoO4,237
|
|
58
58
|
ScriptCollection/TFCPS/DotNet/CertificateGeneratorInformationNoGenerate.py,sha256=i0zEGehj0sttxjjZtoq2KFSKp_ulxVyWp_ZgAhIY_So,241
|
|
59
|
-
ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py,sha256=
|
|
59
|
+
ScriptCollection/TFCPS/DotNet/TFCPS_CodeUnitSpecific_DotNet.py,sha256=Qvri0ydkcXaLw0TNUMD1PVom1ys7Kd0agwlb3Vzk_EI,62668
|
|
60
60
|
ScriptCollection/TFCPS/DotNet/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
61
61
|
ScriptCollection/TFCPS/Flutter/TFCPS_CodeUnitSpecific_Flutter.py,sha256=R-Ldc6XaPETgwrgGqcX3sJ52bDUabusv3MFmFCHCvGY,58340
|
|
62
62
|
ScriptCollection/TFCPS/Flutter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
@@ -72,8 +72,8 @@ ScriptCollection/TFCPS/Rust/TFCPS_CodeUnitSpecific_Rust.py,sha256=yyjWPMHQjPLkML
|
|
|
72
72
|
ScriptCollection/TFCPS/Rust/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
73
73
|
ScriptCollection/TFCPS/TypeScript/TFCPS_CodeUnitSpecific_TypeScript.py,sha256=ILVhJHvwG5TvPBBqSvyACYb7W9QnWrJpxKgHu8IQu4g,9249
|
|
74
74
|
ScriptCollection/TFCPS/TypeScript/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
75
|
-
scriptcollection-4.4.
|
|
76
|
-
scriptcollection-4.4.
|
|
77
|
-
scriptcollection-4.4.
|
|
78
|
-
scriptcollection-4.4.
|
|
79
|
-
scriptcollection-4.4.
|
|
75
|
+
scriptcollection-4.4.41.dist-info/METADATA,sha256=uV7sOZy7d0d9ggn1_pdiTMhfqd8bonPqy5XaG-tRpBQ,7646
|
|
76
|
+
scriptcollection-4.4.41.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
|
|
77
|
+
scriptcollection-4.4.41.dist-info/entry_points.txt,sha256=GNma7tN0J59EvK71su-G1w22RnZ05bXcPrELyLx3AL0,6151
|
|
78
|
+
scriptcollection-4.4.41.dist-info/top_level.txt,sha256=hY2hOVH0V0Ce51WB76zKkIWTUNwMUdHo4XDkR2vYVwg,17
|
|
79
|
+
scriptcollection-4.4.41.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|