Skip to main content

Generate test relted documentation from Zephyrscale Jira Test

Project description

docsteady

docsteady is a python package (and optionally Docker container) that talks to Jira and the Zephy Scale Test Management system to output Test folders and Test plans to a variety of documents by utilizing pandoc.

Quickstart

Pip install the package ::

pip install docsteady>1.2

Credentials are needed by docsteady to log into JIRA. The easiest way to do this is by setting up the following environment variables::

export ZEPHYR_TOKEN= export JIRA_USER= export JIRA_PASSWORD=

The defaults of docsteady are to build documents based on DM defaults. The following commands are available:

  • generate-spec: to generate a Test Specification (baselining test cases)
  • generate-report: for test plans and reports
  • generate-vcd: to generate the Verification Control Documents
  • baseline-ve: to generate Verification Elements baseline documents.

See the docsteady documentation.

Developers

Please refer to the Developer Guide for contribution information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docsteady-3.0.7.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docsteady-3.0.7-py3-none-any.whl (91.5 kB view details)

Uploaded Python 3

File details

Details for the file docsteady-3.0.7.tar.gz.

File metadata

  • Download URL: docsteady-3.0.7.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for docsteady-3.0.7.tar.gz
Algorithm Hash digest
SHA256 4bbb53fb96b1d47dae0b478a3a3a51e3205b822f1da93777c3e6d9e4bfa2f7db
MD5 3286f6796c2fcf501f2ae19fbaf3f89a
BLAKE2b-256 55f51e7eba192e20788bbbbae54edb9972671055a8af431baf97d4b641f7a198

See more details on using hashes here.

Provenance

The following attestation bundles were made for docsteady-3.0.7.tar.gz:

Publisher: ci.yaml on lsst-dm/docsteady

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docsteady-3.0.7-py3-none-any.whl.

File metadata

  • Download URL: docsteady-3.0.7-py3-none-any.whl
  • Upload date:
  • Size: 91.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for docsteady-3.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 564c13dcabe0ce79a92bf97490aeda1772188241cd5f2c8006ffca57af7f774a
MD5 73cc9aad88ee241a9a12dcc64e07f5df
BLAKE2b-256 178150edcd165a770cc326d48a9076c4d2a193057a7e4502aeecd92d6a8eb96d

See more details on using hashes here.

Provenance

The following attestation bundles were made for docsteady-3.0.7-py3-none-any.whl:

Publisher: ci.yaml on lsst-dm/docsteady

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page