plinux 2.1.3
The cross-platform SSH tool to execute bash commands remotely.
Requires Python: >=3.10
Keywords: SSH,Linux,Windows

[![PyPI version](https://badge.fury.io/py/plinux.svg)](https://badge.fury.io/py/plinux)
[![Python application](https://github.com/c-pher/plinux/actions/workflows/pythonapp.yml/badge.svg?branch=master)](https://github.com/c-pher/plinux/actions/workflows/pythonapp.yml)

# Plinux

Cross-platform tool to work with remote Linux OS.

Plinux based on paramiko project. It can establish ssh connection to a remote server, execute command as user or with sudo rights. Plinux returns object with exit code, sent command, stdout/sdtderr response.

## Installation
For most users, the recommended method to install is via pip:
```cmd
pip install plinux
```
## Import
```python
from plinux import Plinux
```
---
## Usage
#### The most recommended usage way:
```python
from plinux import Plinux

client = Plinux(host="172.16.0.124", username="bobby", password="qawsedrf")
response = client.run_cmd("hostname")
print(response.stdout)  # WebServer
print(response.ok)  # True
```
```python
from plinux import Plinux

client = Plinux()
response = client.run_cmd_local("hostname")
print(response.stdout)  # WebServer
print(response.ok)  # True
```

#### Command using sudo:
```python
from plinux import Plinux

client = Plinux(host="172.16.0.124", username="bobby", password="qawsedrf", logger_enabled=True)
response = client.run_cmd("systemctl stop myservicename.service", sudo=True)

print(response)  # SSHResponse(response=(0, None, None, "sudo -S -p '' -- sh -c 'systemctl stop myservicename.service'"))
print(response.command)  # sudo -S -p '' -- sh -c 'systemctl stop myservicename.service'
print(response.exited)  # 0
```

#### SFTP usage:
```python
from plinux import Plinux

tool = Plinux(host="ftp.test.local", username="bobby", password="qawsedrf")
sftp = tool.sftp
print(sftp.listdir())
```

#### SQLite3 usage:
```python
from plinux import Plinux

client = Plinux(host="cdn1.test.local", username="bobby", password="qawsedrf")

db_path = '/opt/ProductName/rxdb/StorageConfig.db'
sql = 'select Data from DtoDataContainer'
db = client.sqlite3(db_path, sql).json()
print(db)  # {"Settings1": 1, "Settings2": 2...,"Settings10": 10}
print(db['Setting1'])  # {"Settings1": 1}
```

#### Aliases

Some methods have "human commands" and aliases:

* client.run_cmd("cat /home/bobby/text")
* client.cat("/home/bobby/text")

Changelog
=========

.. contents::

UNRELEASED
----------

2.1.3
-----
- debug log updated
- package build config updated

2.1.2
-----
- cat_ini returns raw config

2.1.1
-----

- cat_ini: "raw" param added

2.1.0 (5.09.2023)
-----------------

- stdout and stderr will not be stripped

2.0.9 (24.3.2023)
-----------------

- run_cmd changes: timeout param renamed to the exec_timeout and fixed
- client creation params added to debug log

2.0.8.post1 (5.3.2023)
----------------------
- from now on, stdout will not return config
- cat_ini method added instead

2.0.8.post0 (1.3.2023)
----------------------
- reading empty .ini fixed

2.0.8 (28.2.2023)
----------------------
- .cat can read configs (.ini like)
- SSHResponse debug loger added

2.0.7a1 (26.12.2022)
----------------------
Breaking changes. High level methods removing

- cat
- ps
- ls
- cp
- date
- os
- netstat
- start
- stop
- status
- restart
- version
- rm
- chpasswd
- count
- stat
- md5
- ufw
- get_package_info
- get_ssl_serial
- get_ssl_fingerprint
- get_ssl_certificate
- get_ssl_md5
- validate_ssl_key
- kill_user_session
- get_user_id
- get_process_cmdline
- get_port_listeners_process_id
- get_dir_size
- get_disk_size
- get_free_space
- get_disk_usage
- change_password
- count_files
- list_dir
- create_directory
- shutdown
- reboot
- get_processes
- get_md5
- copy_file
- extract_files
- remove
- compare_files
- get_last_file
- delete_line_from_file
- change_line_in_file
- clear_file
- create_file
- get_prelogin
- get_netstat_info
- get_pid
- is_service_enabled
- disable
- enable
- list_active_services
- get_service_journal
- restart_service
- start_service
- kill_service
- stop_service
- is_service_active
- get_service
- get_time_date
- get_date
- get_package_info
- is_security_update_available
- is_package_upgradable
- get_installed_packages_versions
- get_package_version
- get_ufw_status
- get_hostname
- get_ip
- get_os_version

grep_line_in_file renamed to the "grep"

cat_file renamed to the "cat"

2.0.6 (17.11.2022)
----------------------

Methods will not raise exception from now

- reboot
- shutdown
- is_service_active
- is_enabled renamed to is_service_enabled also

get_service_status removed. Use is_service_active instead

2.0.5 (26.10.2022)
----------------------

Fixed methods:

- grep_line_in_file
- is_security_update_available

2.0.4 (26.10.2022)
----------------------

- exists() fixed

2.0.3 (06.10.2022)
----------------------

New method added:

- compare_files()

run_cmd() extended with the "ignore_errors=False" param
Added all other exceptions handler during connection
RemoteCommandExecutionError will rise directly

2.0.2 (06.10.2022)
----------------------

- get_json() removed
- cat_file() extended with pprint param
- get_dir_size() fixed

2.0.1 (06.10.2022)
----------------------

- stdout type hint extended
- get_ntp_servers() fixed to process different ways of data storing in /etc/systemd/timesyncd.conf

2.0.0 (05.10.2022)
----------------------

Breaking changes:

- response with expected exit code != 0 will be warned in log
- ResponseParser changed and renamed to the SSHResponse
- log level added
- log format changed to match another apps
- check_exists renamed to the .exists()
- get_prelogin() new method added to read MOTD
- stat_file() extended. "executable" and time of last access/birth/modification/satus
- get_directory_size refactored and renamed to get_dir_size()
- get_current_os_name() deprecated

Changed type of returned value:
str:

- get_service,
- get_service_status,
- get_service_journal,
- get_ssl_md5,
- get_ssl_certificate,

bool:

- stop_service/kill_service/start_service/restart_service,
- enable/disable,
- get_netstat_info,
- create_file,
- clear_file,
- remove,
- extract_files,
- copy_file,
- reboot,
- shutdown,
- create_directory,
- kill_user_session,

list:
- get_ntp_servers

1.3.8 (22.06.2022)
----------------------

- get_ufw_status() new method added
- change_hostname() obsolete
- get_file_permissions() changes: renamed to stat_file() and return dict now
- get_file_size() deprecated. use .stat_file()
- __sudo_cmd removed

1.3.7 (21.06.2022)
----------------------

- get_package_info(): new method added
- get_md5() returns md5 text only
- list_dir() returns list of files now
- get_free_space() returns string with free space
- get_disk_usage() returns dict with disk usage
- get_last_file() returns str with last file in directory
- cat_file() returns str with file content
- get_package_version() returns str with package version
- get_hostname() returns str with hostname
- get_os_version() returns dict with OS info
- get_ip() returns str with IP address

1.3.6 (07.06.2022)
----------------------

- get_ip_addresses_show() fixed to return info for specific interface

1.3.5 (06.06.2022)
----------------------

python-dateutil added as dependency.

New features:

- get_ntp_servers()
- get_time_date()
- to_known_type() auxiliary method to convert string to python known data type

1.3.4 (03.06.2022)
----------------------

- get_ip_addresses_show() new method added

1.3.3 (17.04.2022)
----------------------

- refactored to manage logger state

1.3.2 (4.04.2022)
----------------------

- exceptions moved to separate "exceptions" module. e.g.

.. code-block:: python

    from plinux.exceptions import PackageNotFoundError

    raise PackageNotFoundError


1.3.1 (4.04.2022)
----------------------

- logger replaced with the plogger package

1.3.0.post1 (22.03.2022)
------------------------

- code cleanup

1.2.9 (22.03.2022)
----------------------

New method added:

- .get_user_id()

1.2.8 (28.02.2022)
----------------------
- .sqlite3() extended with the timeout=1000 param

1.2.7 (22.02.2022)
----------------------
- PackageNotFoundError added

1.2.6 (18.02.2022)
----------------------
New methods added:

- .is_security_update_available()
- .get_disk_size()
- .get_directory_size()
- .get_port_listeners_process_id()
- .get_process_cmdline()

1.2.5 (07.02.2022)
----------------------
.get_json() extended to decode BOM

1.2.4 (21.01.2022)
----------------------
Created instance with local execution by default (host=127.0.0.1).
Python minimum version now is 3.9
New method added:
- get_installed_packages_versions: Get all installed packages and their versions. Returns dict.
Minor: added some methods description

1.2.3 (7.12.2021)
----------------------
New method added:
- get_ssl_fingerprint
- get_ssl_serial
- get_pid fixed to process list of pids

1.2.2 (7.12.2021)
----------------------
get_free_space fixed

- Now it executes command towards "/" and with -h param by default.
- method can accept different number of positional parameters as additional command argument ()
- Specify empty mount_point (the first param as '') to get all disk info

1.2.1 (22.11.2021)
----------------------
Added:

- get_package_version
- is_package_upgradable
- clear_file
- get_ssl_certificate
- validate_ssl_key
- get_ssl_md5

1.2.0 (14.10.2021)
----------------------
- logger added as attr for inheritance

1.1.9 (12.05.2021)
----------------------
- create_file, get_file_size, grep_line_in_file, change_line_in_file, delete_line_from_file, get_last_file, remove,
  extract_files, copy_file, get_md5, create_directory, list_dir to accept "sudo" param

1.1.8 (13.02.2021)
----------------------
- run_cmd_session method added. Can execute several commands one-by-one
- ResponseParser updated to work with run_cmd_session (NOTE: exit code always be 0 for the "run_cmd_session")

1.1.7 (21.12.2020)
----------------------
logger extended to catch destination host

1.1.6 (29.11.2020)
----------------------
sqlite3 method updated to accept external parameters like "-line -header"

1.1.5 (07.11.2020)
----------------------
sqlite3 method added

1.1.4 (06.11.2020)
----------------------
- added 'sftp' property explicitly
- 'cat', 'check_exists', 'get_json' now support sudo usage

1.1.3 (08.08.2020)
----------------------
get_pid method added

1.1.2 (25.04.2020)
----------------------
- send_cmd deprecated
- fix password prompt in stderr


1.1.1 (29.03.2020)
----------------------
get_md5 method added

1.1.0 (19.03.2020)
----------------------
ResponseParser extended with json()


1.0.9 (28.02.2020)
----------------------
Log filehandler writes in utf8 from now

1.0.8 (06.02.2020)
----------------------
get_file_permission extended:
- added faq
- added "human=False" param returns access rights in human readable form otherwise in in octal
- added alias "stat"

1.0.7 (30.01.2020)
----------------------
- ResponseParser methods notation changed.
    - stdout -> str
    - stderr -> str
    - exited -> int
    - ok -> bool
    - command -> str

1.0.6 (29.01.2020)
----------------------
- kill_user_session method added

1.0.5 (26.01.2020)
----------------------
- logging refactored to avoid multiple log entries