Metadata-Version: 2.3
Name: python-utility-scripts
Version: 1.0.10
Summary: Python utility scripts
License: Apache-2.0
Author: dbasunag
Author-email: dbasunag@redhat.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: jira (>=3.6.0,<4.0.0)
Requires-Dist: pyhelper-utils (>=1.0.1,<2.0.0)
Requires-Dist: pylero (>=0.1.0,<0.2.0)
Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
Requires-Dist: python-simple-logger (>=2.0.0,<3.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: tenacity (>=9.0.0,<10.0.0)
Project-URL: Documentation, https://github.com/RedHatQE/python-utility-scripts/blob/main/README.md
Project-URL: Homepage, https://github.com/RedHatQE/python-utility-scripts
Project-URL: Repository, https://github.com/RedHatQE/python-utility-scripts
Description-Content-Type: text/markdown

# python-utility-scripts
Repository for various python utility scripts
* [pyutils-unusedcode](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/unused_code/README.md)
* [pyutils-polarion-verify-tc-requirements](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/polarion/README.md)

## Installation

```bash
pip3 install python-utility-scripts --user
```

## Local run
* Clone the [repository](https://github.com/RedHatQE/python-utility-scripts.git)

```bash
git clone https://github.com/RedHatQE/python-utility-scripts.git
```

* Install [poetry](https://github.com/python-poetry/poetry)

```bash
poetry install
```

## Config file
A config yaml file for various utilities of this repository should be added to
`~/.config/python-utility-scripts/config.yaml`. Script specific config section details can be found in associated script README.md


## 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
```

