pyPolarionCli is a command-line tool designed for easy access to Polarion work items, e.g. for metric creation.
- Overview
- Installation
- Usage
- Commands
- Examples
- Compile into an executable
- Used Libraries
- Issues, Ideas And Bugs
- License
- Contribution
More information on the deployment and architecture can be found in the doc folder.
git clone https://github.com/NewTec-GmbH/pyPolarionCli.git
cd pyPolarionCli
pip install .pyPolarionCli [-h] -u <user> -p <password> -s <server_url> [--version] [-v] {command} {command_options}| Flag | Description |
|---|---|
| --verbose , -v | Print full command details before executing the command. Enables logs of type INFO and WARNING. |
| --version | Import a ticket from a JSON file. |
| --help , -h | Show the help message and exit. |
To connect to the Polarion server, provide all credentials via Command Line arguments:
- --server <server URL> is required.
- ID using --user <user> and --password <password>
| Command | Description |
|---|---|
| search | Search for Polarion work items. |
Check out the all the Examples on how to use the pyPolarionCli tool.
It is possible to create an executable file that contains the tool and all its dependencies. "PyInstaller" is used for this. Just run the following command on the root of the folder:
pyinstaller --noconfirm --onefile --console --name "pyPolarionCli" --add-data "./pyproject.toml;." "./src/pyPolarionCli/__main__.py"Used 3rd party libraries which are not part of the standard Python package:
- polarion - Python library for interacting with Polarion - MIT License
- toml - Parsing TOML - MIT License
If you have further ideas or you found some bugs, great! Create an issue or if you are able and willing to fix it by yourself, clone the repository and create a pull request.
The whole source code is published under BSD-3-Clause. Consider the different licenses of the used third party libraries too!
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.