Metadata-Version: 2.4
Name: pyhelper-utils
Version: 2.0.3
Summary: Collective utility functions for python projects
Project-URL: Homepage, https://github.com/RedHatQE/pyhelper-utils
Project-URL: Repository, https://github.com/RedHatQE/pyhelper-utils
Project-URL: Documentation, https://github.com/RedHatQE/pyhelper-utils/blob/main/README.md
Author-email: Meni Yakove <myakove@gmail.com>, Ruth Netser <rnetser@gmail.com>, Debarati Basu-Nag <dbasunag@redhat.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: ipdb<0.14,>=0.13.13
Requires-Dist: paramiko<6,>=5
Requires-Dist: python-rrmngmnt>=0.1.32
Requires-Dist: python-simple-logger<3,>=2.0.0
Requires-Dist: requests<3,>=2.31.0
Requires-Dist: rich<16,>=15
Requires-Dist: timeout-sampler>=0.0.29
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"))
```
