{ "info": { "author": "Manuel Zubieta", "author_email": "mazubieta@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Build Tools" ], "description": "# tf-vardoc\n\n\n## Important Note\nThis is a _work-in-progress_! It still needs to be \"productionalized\" by making it into a proper commandline utility.\n\n## What is this?\nThis is a utility for generating documentation regarding [Terraform](https://github.com/hashicorp/terraform)\nvariables.\n\n## Why is that important?\n1. The only thing worse than _no documentation_ is _stale/incorrect documentation_.\n2. A part of defining Terraform variables is self-documentatin; you set variable types, descriptions, and defaults as code.\n3. While you could just _read the code_, it's good practice to include a `README.md` for any Terraform module.\n4. This is now a problem if you like to make purdy, stylized `README`s; there's no easy/quick way to transform your\n variable definitions to documentation.\n\n*Until now...*\n\n## How do I use it?\nCreate a `README.md.j2` [jinja2 template](http://jinja.pocoo.org/docs/2.9/). Your variables will be available under\nthe `variables` variable. Stylize to your hearts content.\n\n## TODO\n- make this a proper commandline tool with args and configuration\n- setup pip package\n- distribute", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mazubieta/tf-vardoc", "keywords": "terraform devops documentation", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "tfvardoc", "package_url": "https://pypi.org/project/tfvardoc/", "platform": "", "project_url": "https://pypi.org/project/tfvardoc/", "project_urls": { "Homepage": "https://github.com/mazubieta/tf-vardoc" }, "release_url": "https://pypi.org/project/tfvardoc/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Terraform Documentation Generator/Sync", "version": "0.1.1" }, "last_serial": 3040685, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "69ef1b6cfde637492a7f30968d6bbbbc", "sha256": "3302d9a178ad32e721fc39b452455315845d359b8d909f1ba0cfd093b4cc873f" }, "downloads": -1, "filename": "tfvardoc-0.1.0-py2.7.egg", "has_sig": false, "md5_digest": "69ef1b6cfde637492a7f30968d6bbbbc", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 6195, "upload_time": "2017-07-22T01:47:56", "url": "https://files.pythonhosted.org/packages/88/0e/37b4786385370d0dbe337940da3d4e9b9a298e3e939fe7bf6d71e03e19d4/tfvardoc-0.1.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "f89fb0ec95e3a6d29ffab7ea1719a6fe", "sha256": "9d7ff75f0b486d824636a137ebea94850f4708a51e2fe8929646631470aeac5f" }, "downloads": -1, "filename": "tfvardoc-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f89fb0ec95e3a6d29ffab7ea1719a6fe", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6387, "upload_time": "2017-07-22T01:47:53", "url": "https://files.pythonhosted.org/packages/e7/8c/3d4fecf4272c354254dd65194ad59df679f392323fc0a5b2903fcfffaedd/tfvardoc-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "33e3403341710f9ea6ce4151927a57a4", "sha256": "d48c77d372ab2e1512e9cdda122e2ce334ce6830be29e90673e9b26f39eedf1a" }, "downloads": -1, "filename": "tfvardoc-0.1.0.tar.gz", "has_sig": false, "md5_digest": "33e3403341710f9ea6ce4151927a57a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4037, "upload_time": "2017-07-22T01:47:58", "url": "https://files.pythonhosted.org/packages/57/f7/e6d4ba86bbd85aa3e988203a9c71337ca524627f9b2bc8070c70c328876e/tfvardoc-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "9e7dbea238573e2828da31678e76c8b2", "sha256": "3709e7cdf49654d23d7f702552e8dba3f9902b74725d320ff8058e7594b22413" }, "downloads": -1, "filename": "tfvardoc-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9e7dbea238573e2828da31678e76c8b2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4034, "upload_time": "2017-07-22T01:54:44", "url": "https://files.pythonhosted.org/packages/25/a3/4e4e7bed6d0e600e5848493879463719b8862f75dc7b0a953baefd745056/tfvardoc-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9e7dbea238573e2828da31678e76c8b2", "sha256": "3709e7cdf49654d23d7f702552e8dba3f9902b74725d320ff8058e7594b22413" }, "downloads": -1, "filename": "tfvardoc-0.1.1.tar.gz", "has_sig": false, "md5_digest": "9e7dbea238573e2828da31678e76c8b2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4034, "upload_time": "2017-07-22T01:54:44", "url": "https://files.pythonhosted.org/packages/25/a3/4e4e7bed6d0e600e5848493879463719b8862f75dc7b0a953baefd745056/tfvardoc-0.1.1.tar.gz" } ] }