Skip to main content

ScriptCollection

General

Supported Python versions PyPI Dependencies

CodeFactor Downloads Coverage

The ScriptCollection is the place for reusable scripts.

Reference

The reference can be found here.

Hints

Most of the scripts are written in python 3.

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.

Some functions are not entirely available on windows or require common third-party tools. See the Runtime dependencies-section for more information.

When using ScriptCollection it is not required but recommended for better usability to have epew installed.

Get ScriptCollection

Installation via pip

pip3 install ScriptCollection

See the PyPI-site for ScriptCollection

Download sourcecode using git

You can simply git-clone the ScriptCollection and then use the scripts under the provided license.

git clone https://github.com/anionDevelopment/ScriptCollection.git

It may be easier to pip-install the ScriptCollection but technically pip is not required. Actually you need to git-clone (or download as zip-file from GitHub) the ScriptCollection to use the scripts in this repository which are not written in python.

Troubleshooting

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.

If you have installed the ScriptCollection as pip-package you can simply check the version by running scshowversion or using Python with the following commands:

from ScriptCollection.ScriptCollectionCore import ScriptCollectionCore
ScriptCollectionCore.get_scriptcollection_version()

Or you can simply run pip3 freeze to get information about (all) currently installed pip-packages.

Development

Branching-system

This repository applies the GitFlowSimplified-branching-system.

Repository-structure

This repository applies the CommonProjectStructure as repository-structure.

Install dependencies

ScriptCollection requires Python 3.11 or newer.

To develop ScriptCollection it is obviously required that the following commandline-commands are available on your system:

  • python (on some systems python3)
  • pip3

The pip-packages which are required for developing on this project are defined in ScriptCollection/requirements.txt.

IDE

The recommended IDE for developing ScriptCollection is Visual Studio Code. The recommended addons for developing ScriptCollection with Visual Studio Code are:

Build

To create and install a ScriptCollection locally simply do the following commands in the repository-root:

python ./ScriptCollection/Other/Build/Build.py
pip3 install --force-reinstall ./ScriptCollection/Other/Artifacts/BuildResult_Wheel/scriptcollection-x.x.x-py3-none-any.whl

(Note: x.x.x must be replaced by the appropriate version-number.)

The complete build-pipeline (build, testcases, linting, reference-generation, etc.) is run by scbuildcodeunits in the repository-root (or task bb if Task is installed). Afterwards task dl installs the built wheel locally.

Coding style

In this repository pylint will be used to report linting-issues. If you change code in this repository please ensure pylint does not find any issues before creating a pull-request.

If linting-issues exist in the current code-base can be checked by running python ./ScriptCollection/Other/QualityCheck/Linting.py.

Runtime dependencies

ScriptCollection requires Python 3.11 or newer.

The usual Python-dependencies will be installed automagically by pip.

For functions to read or change the permissions or the owner of a file the ScriptCollection relies on the functionality of the following tools:

  • chmod
  • chown
  • ls

These tools must be available on the system where the functions should be executed. Meanwhile these tools are also available on Windows but may have a slightly limited functionality.

License

See License.txt for license-information.

Metadata

Release files for scriptcollection 4.4.59

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for scriptcollection 4.4.59
File Interpreter ABI Platform Actions
scriptcollection-4.4.59-py3-none-any.whl Python 3 none any Details for scriptcollection-4.4.59-py3-none-any.whl

Release files / scriptcollection-4.4.59-py3-none-any.whl

Download URL scriptcollection-4.4.59-py3-none-any.whl
Size 321.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
51795c806ffc90d9bd833ce9b8d447504376147234145ddd0d4c89fc5ff6aa2d
BLAKE2b-256 checksum
How to use checksums
17eb115e1743357c3a6eb7146abcd7e7916f7cabec9c9598962f732adf408177
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.10

Security for scriptcollection 4.4.59

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

4.4.59 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page