pavel.muhortov/cisco-management
1
0
Fork 0
generated from pavel.muhortov/template-python
Code Issues Pull Requests Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
pavel.muhortov 2023-11-13 19:02:45 +03:00
commit 2316f29c52
4 changed files with 322 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

164
.gitignore vendored Normal file
View File

@ -0,0 +1,164 @@
# ---> Python
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging / credential / logs
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
test/
tmp/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
*.conf
*.log
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
# IntelliJ related files
.idea
*.iml
# VSCode related files
.vscode/*

9
LICENSE Normal file
View File

@ -0,0 +1,9 @@
MIT License
Copyright (c) <year> <copyright holders>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

42
README.md Normal file
View File

@ -0,0 +1,42 @@
# template-python
Template repository for projects on python
* [`script.py`](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 ./script.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 .\script.py
```

107
script.py Normal file
View File

@ -0,0 +1,107 @@
#!/usr/bin/env python3
import logging
from datetime import datetime
from getpass import getuser
from os import path, sep, chdir, devnull
from sys import platform
def execquite(code: int) -> None:
"""Exit procedure.
Args:
code (int): exitcode
"""
if args['show'] != 'qn':
input("Press [ENTER] to continue...")
global time_start
time_execute = datetime.now() - time_start
logging.info(msg='execution time is ' + str(time_execute) + '. Exit.')
exit(code)
def getconfig(config: str) -> dict:
"""Simple config reader.
Args:
config (str): custom configuration file path
Returns:
dict: dictionary as "key":"value"
"""
dictionary = {}
dictionary['log_root'] = None
if path.exists(config):
with open(config) as file:
raw = file.read()
for line in raw.splitlines():
if not line.lstrip().startswith('#') and "=" in line:
if "log_root=" in line:
dictionary['log_root'] = line.split('=')[1].strip()
return dictionary
def checkroot() -> bool:
"""Crossplatform privileged rights checker.
Returns:
bool: True - if privileged rights, False - if not privileged rights
"""
if platform.startswith('linux') or platform.startswith('darwin'):
from os import geteuid
if geteuid() != 0:
return False
else:
return True
elif platform.startswith('win32'):
import ctypes
return ctypes.windll.shell32.IsUserAnAdmin()
if __name__ == "__main__":
from argparse import ArgumentParser
global time_start
time_start = datetime.now()
args = ArgumentParser(
prog='script',
description='Checking privileged rights',
epilog='Dependencies: '
'- Python 3 (tested version 3.9.5)'
)
args.add_argument('-s', '--show', type=str, default=None, required=False,
help='qn - execution without pauses')
args.add_argument('-c', '--conf', type=str, default=None, required=False,
help='path to configuration file')
args = vars(args.parse_args())
conf = path.abspath(__file__).replace('.py', '.conf')
if args['conf']:
conf = args['conf']
conf = getconfig(conf)
log_path = devnull
if conf['log_root']:
log_path = conf['log_root'] + sep + path.splitext(path.basename(__file__))[0] + '.log'
logging.basicConfig(
format='%(asctime)s %(levelname)s: %(message)s',
datefmt='%Y-%m-%d_%H.%M.%S',
handlers=[
logging.FileHandler(
filename=log_path,
mode='a'
),
logging.StreamHandler()
],
level='INFO'
)
chdir(path.split(path.abspath(__file__))[0])
if checkroot():
print('Running as', getuser())
execquite(0)
else:
logging.warning(msg='Restart this as root!')
execquite(1)