Skip to main content

Python-polarion

Build status Coverage Test Documentation Status Downloads

This package allows the user to access many Polarion items like workitems, test run, plans and documents.

Feature overview

This package can, among others, read, modify and create:

  • Workitems
  • Test runs from templates
  • Plans
  • Documents

Work with attachments in workitems and test runs. Work with custom field in workitems and documents.

Installation

pip install polarion

Getting started

Creating the Polarion client and getting workitems, test runs or plans:

from polarion import polarion
client = polarion.Polarion('http://example.com/polarion', 'user', 'password')
project = client.getProject('Python')
workitem = project.getWorkitem('PYTH-510')
run = project.getTestRun('SWQ-0001')
plan = project.getPlan('00002')

Modifying workitems:

workitem.setDescription('Some description..')
workitem.addComment('test comment', 'sent from Python')
workitem.addHyperlink('google.com', workitem.HyperlinkRoles.EXTERNAL_REF)

Or test run results:

run = project.getTestRun('SWQ-0001')
run.records[0].setResult(record.Record.ResultType.PASSED, ' Comment with test result')

Adding workitems to a plan:

plan.addToPlan(workitem)
plan.removeFromPlan(workitem)

More examples to be found in the quick start section of the documentation. Go to the documentation

How does it work?

This project uses the SOAP API of Polarion. This API exposes most of the user interactions you can do with Polarion like creating or editing workitems, plans and test runs. The API is divided in seven different services which you can find from your Polarion instance at the url http://domain.com/polarion/ws/services. Each of the services provides a WSDL file detailing the available functions. (Also available form you local instance at http://domain.com/polarion/ws/services/TrackerWebService?wsdl) For this project the TrackerWebService, PlanningWebService and TestManagementWebService are the most used ones.

In general the project attempts for the objects (like workitems) to behave like Python objects which you can modify and are saved in the background. Where the API provide operation to preform an action that API call is used, and the object is reloaded from polarion to reflect the changes locally.

The API does not allow access to the project administration.

Dependencies

The package uses; requests, urllib3 and zeep.

It is tested for Python version 3.7 through 3.12. Python 3.6 support has been dropped in 1.3.0.

Known issues or missing features

  • No way of knowing the test run possible statuses.
  • Deleting work items used in documents does not remove the reference from the document.

Metadata

Release files for polarion 1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for polarion 1.4.0
File Size Uploaded Provenance
polarion-1.4.0.tar.gz 40.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for polarion 1.4.0
File Interpreter ABI Platform
polarion-1.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 91.2 kB

Release files / polarion-1.4.0.tar.gz

Download URL polarion-1.4.0.tar.gz
Size 40.9 kB
Tags Source
SHA-256 checksum
How to use checksums
df3f57b8f1441d5c84017e334fb0963e4edcef15e2fe3f289ddaae0108669a64
BLAKE2b-256 checksum
How to use checksums
e44def1091883cd5cf2e6f6bc6c195f0b744d3bf1c0e9fb5925ac306fedaacb6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.0

Release files / polarion-1.4.0-py3-none-any.whl

Download URL polarion-1.4.0-py3-none-any.whl
Size 50.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b8edacd84a1b0a164b8c8d4763a9c3c5c4c874745db8ee9d89e26b3d46af89b1
BLAKE2b-256 checksum
How to use checksums
acb12c185c6306e9a3a7405297f9397c64a5ebd1bb8c4076bcd4e0c6c62e44d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.12.0

Security for polarion 1.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page