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

Uploaded Python 3

File details

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

File metadata

  • Download URL: docsteady-3.0.9.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.0.9.tar.gz
Algorithm Hash digest
SHA256 9998b1857cc6a55a600e099df7ca18d901578f627a653a304b356a500136a667
MD5 7582dd0085e97f58b68188fe4452ce13
BLAKE2b-256 4b5c38049104d37c03b3841269e358b5717ee505b7cef8994a8aa3749c4a5d24

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: docsteady-3.0.9-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.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 396dcb74855569b444646cfb18e2e82bd954edb67ec625c1c6baa8a2d11fb117
MD5 7bbfceacc47a98ad17102343e98f8cb6
BLAKE2b-256 54d77cf4c7adf14fd9dea1042eacebcac78966538273631afe4887360ce6cc09

See more details on using hashes here.

Provenance

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