|
1 | 1 | # python-utility-scripts |
| 2 | + |
2 | 3 | Repository for various python utility scripts |
3 | | -* [pyutils-unusedcode](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/unused_code/README.md) |
4 | | -* [pyutils-polarion-verify-tc-requirements](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/polarion/README.md) |
5 | 4 |
|
6 | | -## Installation |
| 5 | +- [pyutils-unusedcode](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/unused_code/README.md) |
| 6 | +- [pyutils-polarion-verify-tc-requirements](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/polarion/README.md) |
| 7 | +- [pyutils-jira](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/jira_utils/README.md) |
| 8 | +- [pyutils-polarion-set-automated](https://github.com/RedHatQE/python-utility-scripts/blob/main/apps/polarion/README.md) |
7 | 9 |
|
8 | | -```bash |
9 | | -pip3 install python-utility-scripts --user |
10 | | -``` |
| 10 | +## Installation |
11 | 11 |
|
12 | | -## Local run |
13 | | -* Clone the [repository](https://github.com/RedHatQE/python-utility-scripts.git) |
| 12 | +using [uv](https://github.com/astral-sh/uv) |
14 | 13 |
|
15 | 14 | ```bash |
16 | | -git clone https://github.com/RedHatQE/python-utility-scripts.git |
| 15 | +uv tool install python-utility-scripts |
17 | 16 | ``` |
18 | 17 |
|
19 | | -* Install [poetry](https://github.com/python-poetry/poetry) |
| 18 | +## Local run |
20 | 19 |
|
21 | | -```bash |
22 | | -poetry install |
23 | | -``` |
| 20 | +- Clone the [repository](https://github.com/RedHatQE/python-utility-scripts.git) |
24 | 21 |
|
25 | 22 | ## Config file |
| 23 | + |
26 | 24 | A config yaml file for various utilities of this repository should be added to |
27 | 25 | `~/.config/python-utility-scripts/config.yaml`. Script specific config section details can be found in associated script README.md |
28 | 26 |
|
29 | | - |
30 | 27 | ## Release new version |
31 | | -### requirements: |
32 | | -* Export GitHub token |
| 28 | + |
| 29 | +### requirements |
| 30 | + |
| 31 | +- Export GitHub token |
33 | 32 |
|
34 | 33 | ```bash |
35 | 34 | export GITHUB_TOKEN=<your_github_token> |
36 | 35 | ``` |
37 | 36 |
|
38 | | -* [release-it](https://github.com/release-it/release-it) |
| 37 | +- [release-it](https://github.com/release-it/release-it) |
39 | 38 |
|
40 | | -* Run the following once (execute outside repository dir for example `~/`): |
| 39 | +- Run the following once (execute outside repository dir for example `~/`): |
41 | 40 |
|
42 | 41 | ```bash |
43 | 42 | sudo npm install --global release-it |
44 | 43 | npm install --save-dev @j-ulrich/release-it-regex-bumper |
45 | 44 | rm -f package.json package-lock.json |
46 | 45 | ``` |
47 | 46 |
|
48 | | -### usage: |
49 | | -* Create a release, run from the relevant branch. |
50 | | -To create a new release, run: |
| 47 | +### usage |
| 48 | + |
| 49 | +- Create a release, run from the relevant branch. |
| 50 | + To create a new release, run: |
51 | 51 |
|
52 | 52 | ```bash |
53 | 53 | git checkout main |
|
0 commit comments