# ScriptCollection
## General
[](https://pypi.org/project/ScriptCollection/)
[](https://www.codefactor.io/repository/github/aniondev/scriptcollection/overview/main)
[](https://pepy.tech/project/scriptcollection)
The ScriptCollection is the place for reusable scripts.
## Reference
The reference can be found [here](https://aniondev.github.io/ScriptCollectionReference/index.html).
## Hints
Most of the scripts are written in [python](https://www.python.org) 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](#runtime-dependencies)-section for more information.
When using ScriptCollection it is not required but recommended for better usability to have [epew](https://github.com/anionDev/Epew) installed.
## Get ScriptCollection
### Installation via pip
`pip3 install ScriptCollection`
See the [PyPI-site for ScriptCollection](https://pypi.org/project/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/anionDev/ScriptCollection.git`
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/anionDev/ScriptCollection) 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](https://github.com/anionDev/ScriptCollection/issues).
If you have installed the ScriptCollection as pip-package you can simply check the version using Python with the following commands:
```lang-bash
from ScriptCollection.ScriptCollectionCore import ScriptCollectionCore
ScriptCollectionCore.get_scriptcollection_version()
```
Or you can simply run `pip3 freeze` folder to get information about (all) currently installed pip-packages.
## Development
### Branching-system
This repository applies the [GitFlowSimplified](https://github.com/anionDev/ProjectTemplates/blob/main/Templates/Conventions/BranchingSystem/GitFlowSimplified.md)-branching-system.
### Repository-structure
This repository applies the [CommonProjectStructure](https://github.com/anionDev/ProjectTemplates/blob/main/Templates/Conventions/RepositoryStructure/CommonProjectStructure/CommonProjectStructure.md)-branching-system.
### Install dependencies
ScriptCollection requires [Python](https://www.python.org) 3.10.
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 `requirements.txt`.
### IDE
The recommended IDE for developing ScriptCollection is Visual Studio Code.
The recommended addons for developing ScriptCollection with Visual Studio Code are:
- [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
- [docs-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown)
### Build
To create and install an ScriptCollection locally simply do the following commands:
```bash
python ./ScriptCollection/Other/Build/Build.py
pip3 install --force-reinstall ./ScriptCollection/Other/Artifacts/Wheel/ScriptCollection-x.x.x-py3-none-any.whl
```
(Note: `x.x.x` must be replaced by the appropriate version-number.)
### Coding style
In this repository [pylint](https://pylint.org/) 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](https://www.python.org) 3.10.
The usual Python-dependencies will be installed automagically by `pip`.
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:
- chmod
- chown
- ls
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.
## License
See [License.txt](https://raw.githubusercontent.com/anionDev/ScriptCollection/main/License.txt) for license-information.
Raw data
{
"_id": null,
"home_page": "https://github.com/anionDev/ScriptCollection",
"name": "ScriptCollection",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "package release build management",
"author": "Marius G\u00f6cke",
"author_email": "marius.goecke@gmail.com",
"download_url": null,
"platform": null,
"description": "# ScriptCollection\r\n\r\n## General\r\n\r\n[](https://pypi.org/project/ScriptCollection/)\r\n\r\n\r\n\r\n[](https://www.codefactor.io/repository/github/aniondev/scriptcollection/overview/main)\r\n[](https://pepy.tech/project/scriptcollection)\r\n\r\n\r\nThe ScriptCollection is the place for reusable scripts.\r\n\r\n## Reference\r\n\r\nThe reference can be found [here](https://aniondev.github.io/ScriptCollectionReference/index.html).\r\n\r\n## Hints\r\n\r\nMost of the scripts are written in [python](https://www.python.org) 3.\r\n\r\nCaution: 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.\r\n\r\nSome functions are not entirely available on windows or require common third-party tools. See the [Runtime dependencies](#runtime-dependencies)-section for more information.\r\n\r\nWhen using ScriptCollection it is not required but recommended for better usability to have [epew](https://github.com/anionDev/Epew) installed.\r\n\r\n## Get ScriptCollection\r\n\r\n### Installation via pip\r\n\r\n`pip3 install ScriptCollection`\r\n\r\nSee the [PyPI-site for ScriptCollection](https://pypi.org/project/ScriptCollection)\r\n\r\n### Download sourcecode using git\r\n\r\nYou can simply git-clone the ScriptCollection and then use the scripts under the provided license.\r\n\r\n`git clone https://github.com/anionDev/ScriptCollection.git`\r\n\r\nIt 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/anionDev/ScriptCollection) the ScriptCollection to use the scripts in this repository which are not written in python.\r\n\r\n## Troubleshooting\r\n\r\nIt 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/anionDev/ScriptCollection/issues).\r\n\r\nIf you have installed the ScriptCollection as pip-package you can simply check the version using Python with the following commands:\r\n\r\n```lang-bash\r\nfrom ScriptCollection.ScriptCollectionCore import ScriptCollectionCore\r\nScriptCollectionCore.get_scriptcollection_version()\r\n```\r\n\r\nOr you can simply run `pip3 freeze` folder to get information about (all) currently installed pip-packages.\r\n\r\n## Development\r\n\r\n### Branching-system\r\n\r\nThis repository applies the [GitFlowSimplified](https://github.com/anionDev/ProjectTemplates/blob/main/Templates/Conventions/BranchingSystem/GitFlowSimplified.md)-branching-system.\r\n\r\n### Repository-structure\r\n\r\nThis repository applies the [CommonProjectStructure](https://github.com/anionDev/ProjectTemplates/blob/main/Templates/Conventions/RepositoryStructure/CommonProjectStructure/CommonProjectStructure.md)-branching-system.\r\n\r\n### Install dependencies\r\n\r\nScriptCollection requires [Python](https://www.python.org) 3.10.\r\n\r\nTo develop ScriptCollection it is obviously required that the following commandline-commands are available on your system:\r\n\r\n- `python` (on some systems `python3`)\r\n- `pip3`\r\n\r\nThe pip-packages which are required for developing on this project are defined in `requirements.txt`.\r\n\r\n### IDE\r\n\r\nThe recommended IDE for developing ScriptCollection is Visual Studio Code.\r\nThe recommended addons for developing ScriptCollection with Visual Studio Code are:\r\n\r\n- [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\r\n- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\r\n- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)\r\n- [docs-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown)\r\n\r\n### Build\r\n\r\nTo create and install an ScriptCollection locally simply do the following commands:\r\n\r\n```bash\r\npython ./ScriptCollection/Other/Build/Build.py\r\npip3 install --force-reinstall ./ScriptCollection/Other/Artifacts/Wheel/ScriptCollection-x.x.x-py3-none-any.whl\r\n```\r\n\r\n(Note: `x.x.x` must be replaced by the appropriate version-number.)\r\n\r\n### Coding style\r\n\r\nIn this repository [pylint](https://pylint.org/) will be used to report linting-issues.\r\nIf you change code in this repository please ensure pylint does not find any issues before creating a pull-request.\r\n\r\nIf linting-issues exist in the current code-base can be checked by running `python ./ScriptCollection/Other/QualityCheck/Linting.py`.\r\n\r\n## Runtime dependencies\r\n\r\nScriptCollection requires [Python](https://www.python.org) 3.10.\r\n\r\nThe usual Python-dependencies will be installed automagically by `pip`.\r\n\r\nFor functions to to read or change the permissions or the owner of a file the ScriptCollection relies on the functionality of the following tools:\r\n\r\n- chmod\r\n- chown\r\n- ls\r\n\r\nThis 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.\r\n\r\n## License\r\n\r\nSee [License.txt](https://raw.githubusercontent.com/anionDev/ScriptCollection/main/License.txt) for license-information.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "The ScriptCollection is the place for reusable scripts.",
"version": "3.5.1",
"project_urls": {
"Changelog": "https://github.com/anionDev/ScriptCollection/tree/main/Other/Resources/Changelog",
"Documentation": "https://aniondev.github.io/ScriptCollectionReference/index.html",
"Homepage": "https://github.com/anionDev/ScriptCollection"
},
"split_keywords": [
"package",
"release",
"build",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "12c608ec54f89572c83ea13874e3322f58981cab2d14e7d23044278314c7b3a2",
"md5": "808996cbe9bf3ce0991440bb19f7f776",
"sha256": "0670f1c6c5924c4c6f6ad5c1bdeba7d87433c3e80e06d555b2cf2d13c8f34d69"
},
"downloads": -1,
"filename": "ScriptCollection-3.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "808996cbe9bf3ce0991440bb19f7f776",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 67282,
"upload_time": "2024-04-29T23:39:06",
"upload_time_iso_8601": "2024-04-29T23:39:06.662282Z",
"url": "https://files.pythonhosted.org/packages/12/c6/08ec54f89572c83ea13874e3322f58981cab2d14e7d23044278314c7b3a2/ScriptCollection-3.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 23:39:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "anionDev",
"github_project": "ScriptCollection",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scriptcollection"
}
JSON
