Metadata-Version: 2.1
Name: pyhelper-utils
Version: 0.0.30
Summary: Collective utility functions for python projects
Home-page: https://github.com/RedHatQE/pyhelper-utils
License: Apache-2.0
Author: Meni Yakove
Author-email: myakove@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: ipdb (>=0.13.13,<0.14.0)
Requires-Dist: python-rrmngmnt (>=0.1.32,<0.2.0)
Requires-Dist: python-simple-logger (>=1.0.19,<2.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Project-URL: Documentation, https://github.com/RedHatQE/pyhelper-utils/blob/main/README.md
Project-URL: Repository, https://github.com/RedHatQE/pyhelper-utils
Description-Content-Type: text/markdown

# pyhelper-utils

Repository for various python utilities

## Installation

```bash
python3 -m pip install pyhelper-utils
```

## Release new version

### requirements:

- Export GitHub token

```bash
export GITHUB_TOKEN=<your_github_token>
```

- [release-it](https://github.com/release-it/release-it)

- Run the following once (execute outside repository dir for example `~/`):

```bash
sudo npm install --global release-it
npm install --save-dev @j-ulrich/release-it-regex-bumper
rm -f package.json package-lock.json
```

### usage:

- Create a release, run from the relevant branch.
  To create a new release, run:

```bash
git checkout main
git pull
release-it # Follow the instructions
```

### Examples:

Enables running a command against a remote server over SSH. It expects a host object, created using [python-rrmngmnt](https://github.com/rhevm-qe-automation/python-rrmngmnt).

#### Sample code:

```bash
from rrmngmnt import Host, UserWithPKey
host = Host("1.1.1.1")
user = UserWithPKey('user', '/path/to/pkey'))
host.executor_user =  user
run_ssh_command(host=host, commands=shlex.split("ls -l"))
```

