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.8.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.8-py3-none-any.whl (91.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docsteady-3.0.8.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.8.tar.gz
Algorithm Hash digest
SHA256 121b26c8618508988f9e36bff185f2c88af0b0fb0d274a94f9acddbadc5558ad
MD5 91aac63a958ad017aa980f96b443f4ad
BLAKE2b-256 3635a2375a58b578c6d0f3f9fff456abf3efbb36e9dcdc41cccd1f91b72d4b56

See more details on using hashes here.

Provenance

The following attestation bundles were made for docsteady-3.0.8.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.8-py3-none-any.whl.

File metadata

  • Download URL: docsteady-3.0.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1619a7596add3580eccd136f3ddfd4eca8dacb1cf2abec1b45dc3546d693631f
MD5 7faac05f8e6bc58ca11153d815967249
BLAKE2b-256 20a758109cefd2c06bbc45e6db3c60d5d99d98a5c4dc9f3152136b65dee5ab81

See more details on using hashes here.

Provenance

The following attestation bundles were made for docsteady-3.0.8-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