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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docsteady-3.1.2.tar.gz
Algorithm Hash digest
SHA256 44b17ea85e4bf8305a64c67fdaef6ed462cc45082fa1daf50a7933d41d1c7cfd
MD5 93bbb847bfb55238e85eb34b63ceec72
BLAKE2b-256 b8c87336284f46eaffeb57c5bd1089d04d2be4c41d69ab3124b6bcd64f2531ee

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: docsteady-3.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7ecc1b271b9fca5e3b45c4f4b9a8b0110c099aca263fc29bb061c5dde40dbdac
MD5 51b39911dbe6cea6dec9ad827cebf5f0
BLAKE2b-256 79c586d13315e2e47d932f44b2fd0bd762bd5d6bcea7fa3f34d3219087618ff5

See more details on using hashes here.

Provenance

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