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.4.tar.gz (1.4 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.4-py3-none-any.whl (91.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docsteady-3.1.4.tar.gz
  • Upload date:
  • Size: 1.4 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.4.tar.gz
Algorithm Hash digest
SHA256 2d7e6e4bb1fe39f0bbe6579164b883949ebaa09490b2a77ded4d9cee6a6669d7
MD5 1eadef73659f010c0d852e221d1bf020
BLAKE2b-256 505ac6f8054bdb3f3fbdbf977383e9c3aba5ec82b4c56eddbb844c1f8d623ca4

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: docsteady-3.1.4-py3-none-any.whl
  • Upload date:
  • Size: 91.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bea0855468cd2237301e56bb83a0cf3fb0226e6c3c74181c092bc0837198ea93
MD5 cb01a0fc024788abebc10f05922d45db
BLAKE2b-256 11c400d0f3e23532c82ef69315547d9d446d904b59fbfc827d6623248b75c53d

See more details on using hashes here.

Provenance

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