https://github.com/nocturnalbeast/alm-cutie
A Python script to export all tests from a QC ALM test plan.
https://github.com/nocturnalbeast/alm-cutie
alm hpalm python python3 qc-alm-rest-api rest-api
Last synced: about 1 month ago
JSON representation
A Python script to export all tests from a QC ALM test plan.
- Host: GitHub
- URL: https://github.com/nocturnalbeast/alm-cutie
- Owner: nocturnalbeast
- License: mit
- Created: 2021-12-19T20:28:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-23T06:31:54.000Z (over 4 years ago)
- Last Synced: 2025-03-22T23:41:46.133Z (about 1 year ago)
- Topics: alm, hpalm, python, python3, qc-alm-rest-api, rest-api
- Language: Python
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cutie.py
## Description
This is a small tool that I wrote for myself in order to help with extracting the complete test plan from my org's QC ALM instance.
I took on this project since the ALM REST API is quite restrictive, and the interface is clunky to say the least.
I'm opensourcing this in hopes that someone that faced the same frustration in dealing with QC ALM finds this and can possibly make use of this tool.
## Requirements
Python version(s) 3.7 and above should be supported, but not tested - 3.9 and above is tested.
The following libraries are used in this tool:
- [rich](https://pypi.org/project/rich/)
- [beautifulsoup4](https://pypi.org/project/beautifulsoup4/)
- [requests](https://pypi.org/project/requests/)
- [xlsxwriter](https://pypi.org/project/XlsxWriter/)
- [lxml](https://pypi.org/project/lxml/)
- [yaml](https://pypi.org/project/PyYAML/)
- [yamlloader](https://pypi.org/project/yamlloader/)
Install them in your Python environment before you start using this tool.
## FAQ
- **How do I use it?**
Install the required libraries mentioned in the *Requirements* section into your preferred Python environment.
Generate the default `preferences.yaml` file using the command `python cutie.py -g`.
Customize the preferences file obtained to match your ALM and network environment.
Once done, run `python cutie.py` to get help on how to use the tool.
Example invocation for test plan export: `python cutie.py -p preferences.yaml -o output.xlsx`
- **What's next? Moar features?**
I hope to extend the usage of this tool to cover other aspects like covering all CRUD operations on the ALM database.
At the very least, I'll be adding some filtering options into the export operation.
- **Why the name?**
Since cutie.py sounded like cutiepie.