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.2.tar.gz (453.9 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.2-py3-none-any.whl (90.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docsteady-3.0.2.tar.gz
Algorithm Hash digest
SHA256 bd6d469c8d1d126eaa9f54e47a30a4bdd09c25ceb72ce9f51db73cdffba81f52
MD5 5d9f615a71f2458dfeaad9f31de66257
BLAKE2b-256 52150a3ad60bc300cc740fe588dc556b23d56ec189a1a63e114ab791d325f5dc

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for docsteady-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0500a307dd2134ab08d48c4e266bec16318f850db0b949cc5f1b1819cd5c3325
MD5 6f04c03fb838c0daa1822ea1e21de043
BLAKE2b-256 d10b74f8afeaf6a86542a5a87cc1eb4021b7a12b1fc9d83395bb01f7b880d724

See more details on using hashes here.

Provenance

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