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

Uploaded Python 3

File details

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

File metadata

  • Download URL: docsteady-3.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 5303d37ad24ba5021fccf3182716665744ea64e5c6d64d7f1f1a742de4f61d7b
MD5 2a189d44dea8f75fe0ee37b2a6a02346
BLAKE2b-256 45efa61f9d23dd60549be80c16ce973a10dc2e4c04221a666f86f6dbbc71ecb3

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: docsteady-3.0.6-py3-none-any.whl
  • Upload date:
  • Size: 91.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 aa65699330ecc0500a02a471e2953df0c8fa1676df9c716c729f737b4bedc56f
MD5 244df72a2c51892ba057a98c697a8bee
BLAKE2b-256 37ef9b86aa1e8a9b2ff9f557eee1412cd8b700b611d7437be8c64224a68e9193

See more details on using hashes here.

Provenance

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