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.3.tar.gz (454.2 kB 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.3-py3-none-any.whl (91.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docsteady-3.0.3.tar.gz
Algorithm Hash digest
SHA256 fffd3f0191a112023e0837932360b105b0238b2ba506c0875b9bdcc7823dde44
MD5 077528b927769d2c87ae8518aca7602c
BLAKE2b-256 939d80a64499deaa5281867ca1ff37e9e90391af52ec6e34b84c3522fa84c452

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: docsteady-3.0.3-py3-none-any.whl
  • Upload date:
  • Size: 91.0 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 27b1e22132cf012b0d0723bdf5071f3c2fe0ac0d9697a4eb1f657bc6996a1ce4
MD5 466df77ff621c55594d66e3e6fb958c2
BLAKE2b-256 f5b80d59f3d948dada917afb5b6341c47187e483efcf53216ef39fc95165665e

See more details on using hashes here.

Provenance

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