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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docsteady-3.1.0.tar.gz
Algorithm Hash digest
SHA256 daef03b14341044be405427cbdfae8d1d81cc2ead5b2cfff0ca72f3e7061c49c
MD5 98e77a98aa1b5925408e5c7bda3591cf
BLAKE2b-256 bd9db53558cb6447f2a49293f075690142551222da5e272a7499ccbc7f40983b

See more details on using hashes here.

Provenance

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

File metadata

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

File hashes

Hashes for docsteady-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dca2d199f7f3857ad0342b84ffccc987a1719306e9b9ec419742dab29b5468bb
MD5 659995590ef38a32d10bfda98e471238
BLAKE2b-256 c68e41fc1d1fe871f5c40781049dd65b86b7a7011bd503c8debb554fef857863

See more details on using hashes here.

Provenance

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