add basic design

This commit is contained in:
pavel.muhortov 2023-01-08 16:16:31 +03:00
parent c940149d12
commit 0a36399509

View File

@ -1,3 +1,37 @@
# template-python # template-python
Template repository for projects on python Template repository for projects on python
* [`script.sh`](https://git.hmp.today/pavel.muhortov/template-python#script-py)
____
## `script.py`
**Description:**
> returning current username if privileged rights are exist
> or
> returning error, if privileged rights are not exist
**Dependencies:**
> - Python 3 (tested version 3.9.5)
| PARAMETERS | DESCRIPTION | DEFAULT|
|-------------|-------------|--------|
|**[-s,--show]**|"" - execution with pauses.<br/>"qn" - execution without pauses.||
|**[-c,--conf]**|path to configuration file|./script.conf|
Example usage in terminal with Python on Linux:
```shell
python3 ./procutil.py
```
Example usage in terminal with make the script executable on Linux:
```shell
chmod u+x ./script.py
script.py -s qn -c ./script.conf
```
Example usage in terminal with Python on Windows:
```shell
python .\procutil.py
```