Metadata-Version: 2.1
Name: ssm-dox
Version: 0.1.1
Summary: CLI tool for building and publishing SSM Documents.
Home-page: https://github.com/ITProKyle/ssm-dox
License: Apache-2.0
Keywords: cli
Author: Kyle Finley
Author-email: kyle@finley.sh
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Utilities
Provides-Extra: docs
Requires-Dist: PyYAML (>=4.1,<5.3)
Requires-Dist: Sphinx (>=3.5.2,<4.0.0); extra == "docs"
Requires-Dist: boto3 (>=1.17.23,<2.0.0)
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: coloredlogs (>=15.0,<16.0)
Requires-Dist: pydantic (>=1.8.1,<2.0.0)
Requires-Dist: readthedocs-sphinx-search (>=0.1.0,<0.2.0); extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=0.5.1,<0.6.0); extra == "docs"
Requires-Dist: toml (>=0.10.2,<0.11.0); extra == "docs"
Project-URL: Bug Tracker, https://github.com/ITProKyle/ssm-dox/issues
Project-URL: Repository, https://github.com/ITProKyle/ssm-dox
Description-Content-Type: text/markdown

# ssm-dox

[![PyPi](https://img.shields.io/pypi/v/ssm-dox?style=flat)](https://pypi.org/project/ssm-dox/)
[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat)](https://github.com/psf/black)
[![Documentation Status](https://readthedocs.org/projects/ssm-dox/badge/?version=latest)](https://ssm-dox.readthedocs.io/en/latest/?badge=latest)

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.

