{
    "info": {
        "author": "Ryan Ash",
        "author_email": "ryanash@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Topic :: System :: Distributed Computing",
            "Topic :: System :: Systems Administration"
        ],
        "description": "# Automated Cloud Custodian Policy Documentation\n\n## What is c7n-autodoc?\n\nAutomated Cloud Custodian policy documentation for your business partners.\n\n## Why use c7n-autodoc?\n\nAdministrators of cloud platforms need provide their business partners\nwith clear and accurate documentation regarding the security, governance and\ncost control policies.  The easiest way to stay on top of your documentation \nis to automate it.  This utility will create an HTML file with easy to read information\nregarding your existing Cloud Custodian policies.  \n\nFeatures include:\n* Automatically writes to S3 bucket\n* Groups policies by resource type\n* Groups policies by category (i.e 'Security & Governance' vs 'Cost Controls')\n* Provide links to underlying file in GitLab/GitHub\n* Uses policy tags to determine applicable environments\n\n## Assumptions\n\n* You have added any necessary security controls to the destination S3 bucket\n* Local credentials exist for the boto3 module to push the file to S3\n\n## Installation\n\n<i>NOTE: Requires python3</i>\n\n  pip3 install pyyaml boto3 jinja2 jsonschema\n\n## Configuration\n\nThe only item you should need to customize is the configuration YAML file which is required by the \nscript.  Look at the example file provided to determine which fields are required and which \nare optional.  You can also customize the jinja2 template to further modify the HTML \ndocumentation which is created. \n\nThe S3 bucket which will house the HTML file needs to have `Static website hosting` enabled.  The \ndefault (index.html, error.html) are fine because you will be directly targeting the c7n-autodoc.html\nfile.\n\n## Run\n\nFor the best results this script should be run as a part of a CI/CD pipeline. \n\n  python3 c7n-autodoc.py -c my_config_file.yml\n\nAssuming there aren't any issues you should see the HTML file in the S3 bucket.\n\n## Example \n\n![alt text](images/c7n-autodoc_example2.png \"Example c7n-autodoc\")\n\n## TODO\n\n* Account for different policies for proper rendering\n* Improved UI layout\n* Easier user setup",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/cloud-custodian/cloud-custodian",
        "keywords": "",
        "license": "Apache-2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "c7n-autodoc",
        "package_url": "https://pypi.org/project/c7n-autodoc/",
        "platform": "",
        "project_url": "https://pypi.org/project/c7n-autodoc/",
        "project_urls": {
            "Homepage": "https://github.com/cloud-custodian/cloud-custodian"
        },
        "release_url": "https://pypi.org/project/c7n-autodoc/0.3/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Cloud Custodian - Automated Policy Documentation",
        "version": "0.3"
    },
    "last_serial": 5137739,
    "releases": {
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1406768b3aabe18555cb71178f3f46e0",
                    "sha256": "9abd335627f24b5a1289ec549671e384952a472cd0273f2e9aaa620d4227e0f5"
                },
                "downloads": -1,
                "filename": "c7n_autodoc-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "1406768b3aabe18555cb71178f3f46e0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2530,
                "upload_time": "2019-04-13T10:09:37",
                "url": "https://files.pythonhosted.org/packages/d6/aa/a45a1b42fa11fb6244cfab811ee7c5f99b30a88dcd4d8e4fd71b39cb998b/c7n_autodoc-0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "1406768b3aabe18555cb71178f3f46e0",
                "sha256": "9abd335627f24b5a1289ec549671e384952a472cd0273f2e9aaa620d4227e0f5"
            },
            "downloads": -1,
            "filename": "c7n_autodoc-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "1406768b3aabe18555cb71178f3f46e0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2530,
            "upload_time": "2019-04-13T10:09:37",
            "url": "https://files.pythonhosted.org/packages/d6/aa/a45a1b42fa11fb6244cfab811ee7c5f99b30a88dcd4d8e4fd71b39cb998b/c7n_autodoc-0.3.tar.gz"
        }
    ]
}