Skip to main content

CLI tool for building and publishing SSM Documents.

Project description

ssm-dox

PyPi code style: black Documentation Status

CLI tool for building and publishing SSM Documents.

What Is Dox?

Dox is a directory containing the source code of an SSM document. Named for it's corresponding SSM Document, the directory contains the following:

  • template.yaml or template.yml file [REQUIRED]
  • README.md file describing the SSM Document
  • external files to be included in the SSM Document (e.g. shell or PowerShell scripts)

Why Use Dox?

Using Dox to write an SSM Document allows for scripts and other items to be linted and tested outside of the SSM Document. This enables CI/CD pipelines to easily validate the code before it gets deployed to AWS.

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

ssm-dox-0.2.0.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

ssm_dox-0.2.0-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file ssm-dox-0.2.0.tar.gz.

File metadata

  • Download URL: ssm-dox-0.2.0.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Darwin/20.6.0

File hashes

Hashes for ssm-dox-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5f2c3fd69e578761bb9b149fcc7626f97e5e1a948a8278946ae9c1cc61aa98e7
MD5 1beacfbe81f806caf094cb3e2de28b3e
BLAKE2b-256 3fef01759d1921821d7465809b901b2e8d622243e4695218a65975e31198af22

See more details on using hashes here.

File details

Details for the file ssm_dox-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: ssm_dox-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.1 Darwin/20.6.0

File hashes

Hashes for ssm_dox-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 471449c483d7f97c5c4d9ad3427819b717776cdee9155718b7462e293567d044
MD5 2bb9f26a2cfbcf688570a750443f3712
BLAKE2b-256 10d4e95b4c1e8275a9115c076113c53c328d31f705f97435412cbb65f09d40b2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page