Metadata-Version: 2.1
Name: ScriptCollection
Version: 2.5.9
Summary: The scriptcollection is the place for little scripts which are maybe also useful in future.
Home-page: https://github.com/anionDev/ScriptCollection
Author: Marius Göcke
Author-email: marius.goecke@gmail.com
License: MIT
Platform: windows10
Platform: linux
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Terminals
Description-Content-Type: text/markdown
Requires-Dist: defusedxml (>=0.7.1)
Requires-Dist: keyboard (>=0.13.5)
Requires-Dist: lxml (>=4.6.3)
Requires-Dist: ntplib (>=0.3.4)
Requires-Dist: pycdlib (>=1.10.0)
Requires-Dist: PyPDF2 (>=1.26.0)
Requires-Dist: qrcode (>=6.1)
Requires-Dist: send2trash (>=1.5.0)

# ScriptCollection

![PyPI](https://img.shields.io/pypi/v/ScriptCollection)
[![CodeFactor](https://www.codefactor.io/repository/github/aniondev/scriptcollection/badge/master)](https://www.codefactor.io/repository/github/aniondev/scriptcollection/overview/master)
![Generic badge](https://img.shields.io/badge/coverage-1%25-green)

This repository is the place for little scripts which are also useful in future so that someone does not have remember them and write them new from scratch. You can simply use the scripts.

When using ScriptCollection it is not required but recommended for better usability to have [epew](https://github.com/anionDev/Epew) installed.

## Functions

TODO

## 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.

## Get ScriptCollection

### Installation via pip

`pip3 install ScriptCollection`

pip3 requires [Python](https://www.python.org) 3. 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`

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.core import get_ScriptCollection_version
get_ScriptCollection_version()
```

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

## Development

### Install dependencies

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

- `python` (on some systems `python3`)
- `pip3`

To install all required pip-packages simply execute the following commands:

```lang-bash
pip3 install "defusedxml>=0.7.1"
pip3 install "keyboard>=0.13.5"
pip3 install "ntplib>=0.3.4"
pip3 install "pycdlib>=1.10.0"
pip3 install "PyPDF2>=1.26.0"
pip3 install "qrcode>=6.1"
pip3 install "send2trash>=1.5.0"
pip3 install "pylint>=2.6.0"
pip3 install "pytest>=6.1.2"
pip3 install "wheel>=0.35.1"
```

### IDE

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

- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- [Python Test Explorer for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=LittleFoxTeam.vscode-python-test-adapter)
- [Spell Right](https://marketplace.visualstudio.com/items?itemName=ban.spellright)
- [docs-markdown](https://marketplace.visualstudio.com/items?itemName=docsmsft.docs-markdown)

### Build

To Create an installable whl-package simply execute `python Setup.py bdist_wheel --dist-dir .`.

## Runtime-Dependencies

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/master/License.txt) for license-information.


