https://github.com/developerstoolbox/check-prerequisites-package
Check prerequisite are meet for commands that need to be run.
https://github.com/developerstoolbox/check-prerequisites-package
prerequisites python wolfsoftware
Last synced: 4 months ago
JSON representation
Check prerequisite are meet for commands that need to be run.
- Host: GitHub
- URL: https://github.com/developerstoolbox/check-prerequisites-package
- Owner: DevelopersToolbox
- License: mit
- Created: 2024-05-22T12:37:08.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T15:10:40.000Z (almost 2 years ago)
- Last Synced: 2024-05-22T15:17:34.253Z (almost 2 years ago)
- Topics: prerequisites, python, wolfsoftware
- Language: Python
- Homepage:
- Size: 0 Bytes
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
## Overview
When you write a script or tool which uses subprocess to execute shell commands, you want to know if the commands are installed or not. This is
particularly important if you are running multiple commands which rely on each other.
You can of course catch the exceptions through using `check=True` but if you need to know they all exist before you start your execution run then
this doesn't help you as it only handled the failure it currently has.
This little package assist with that problem by taking a list of commands that must be installed and available and verifies that list at the start to
ensure all of them are available.
## Installation
```shell
pip install wolfsoftware.prereqs
```
## Usage
```python
import sys
from wolfsoftware.prereqs import check_prerequisite, PrerequisiteCheckError
prerequisites: list[str] = ["python", "git"]
try:
command_paths: dict = check_prerequisite(prerequisites)
except PrerequisiteCheckError as err:
print("Prerequisite check failed:")
for error in err.errors:
print(error)
sys.exit(0)
print(command_paths['python'])
```
Once the checks have completed, you now have a dict of commands and their associated paths which you can then utilise to ensure you are executing
your subprocesses with the full path.
