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

Uploaded Python 3

File details

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

File metadata

  • Download URL: docsteady-3.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 67a8a29e4478cb37a48a48431deebc562344a1e32a05348b6bfd0722ba386ea8
MD5 704e726455add8260e7e4f28f3e67f3d
BLAKE2b-256 df40f173687d50f7ccce1dd13deff2327e3405d41afe6b2308e663f226bbbfc3

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: docsteady-3.1.3-py3-none-any.whl
  • Upload date:
  • Size: 91.5 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 46b0493b2b47bb5f8843298580d5de271a17dd4500343551e5cee684363c2c0c
MD5 ad548a5e6fba8d49cae586e0c825de77
BLAKE2b-256 7c7c2d0b5ce16170f0e1d2a01a4ac0c05af93af16051a6a1654e8f724959f920

See more details on using hashes here.

Provenance

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