{
    "info": {
        "author": "Christo Crampton",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Ansible-DocGen\nA python utility for generating Ansible README.md files for roles\n\n[![Build Status](https://travis-ci.org/toast38coza/Ansible-DocGen.svg?branch=master)](https://travis-ci.org/toast38coza/Ansible-DocGen)\n\n* Ansible-DocGen is tested in `python3`\n\n\n## Installation\n\n### PIP\n\n    pip install ansible-docgeneration\n    \n**Note if you installed it from pip, you will need to use it like so from the command line:**\n\n    python -m docgen\n\n### From Source\n\n```\ngit clone git@github.com:toast38coza/Ansible-DocGen.git\ncd Ansible-DocGen\nvirtualenv-3.4 env -p python3\nsource env/bin/activate\npip install -r requirements.txt\n```\n\n## Usage\n\n```\nUsage: docgen.py [OPTIONS]\n\n# Basic usage: \npython docgen.py\n\n#Specify a path to a role: \npython docgen.py --path=/path/to/ansible/role\n\n#Specify a path to a role, and output the result to a file: \npython docgen.py --path=/path/to/ansible/role > /path/to/ansible/role/README.md\n```\n\n**Options:**\n\n* `--path`  Path to your role (defaults to current directory)\n* `--help`       Show this message and exit.\n\n## Test \n\n.. coming soon\n\n## Example output:\n\nA role for settings up a django application\n\n* **Required ansible version:** >= 1.2\n\n\n## Required variables:\n| Parameter    | Example  | Comment  |\n|--------------|----------|----------|\n|`django_app_name`|`polls`|The name of your application. Typcially this will be the name of the folder containing your settings.py file|\n\n\n## Optional variables:\n\n| Parameter    | Default | \n|--------------|----------|\n|`django_settings_directory_path`|`{{django_app_path}}/{{django_project_name}}`|\n|`django_gunicorn_workers`|`2`|\n|`django_venv_path`|`/srv/venvs/{{django_app_name}}`|\n|`django_media_path`|`/srv/{{django_app_name}}/media`|\n|`django_http_port`|`8000`|\n|`manage_commands`|`['collectstatic', 'syncdb', 'migrate']`|\n|`django_settings_vars`|`[]`|\n|`django_static_path`|`/srv/{{django_app_name}}/static`|\n|`django_log_path`|`/var/log/{{django_app_name}}`|\n|`django_requirements_location`|`{{django_app_path}}/requirements.txt`|\n|`django_env_vars`|`[]`|\n|`django_version`|`1.8`|\n|`django_app_path`|`/var/www/{{django_app_name}}`|\n|`django_github_version`|`master`|\n\n\n### Basic usage\n\n```\n- hosts: all\n  vars:\n    - django_app_name: polls\n  roles:\n    - { role: django, tags: django }\n\n```\n\n### TODO\n\n* TODO: use pex to package virtualenv\n* Unit testing\n* Travis CI \n* Better error handling",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/toast38coza/Ansible-DocGen",
        "keywords": "",
        "license": "MIT licence",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ansible-docgenerator",
        "package_url": "https://pypi.org/project/ansible-docgenerator/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/ansible-docgenerator/",
        "project_urls": {
            "Homepage": "https://github.com/toast38coza/Ansible-DocGen"
        },
        "release_url": "https://pypi.org/project/ansible-docgenerator/0.1.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Simple tool for generating ansible role documentation",
        "version": "0.1.0"
    },
    "last_serial": 1793180,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "942e05b03fbafb17eda6a8486d0b69ce",
                    "sha256": "d547245718238f4ead9b2a276069b55f7e47b3290e1258b43c657c73baf51cf5"
                },
                "downloads": -1,
                "filename": "ansible-docgenerator-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "942e05b03fbafb17eda6a8486d0b69ce",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3017,
                "upload_time": "2015-10-30T08:30:16",
                "url": "https://files.pythonhosted.org/packages/ee/64/e2d192c3c10479e0ca2687c04dd69273562c7b486c2b7d707c8daf74436d/ansible-docgenerator-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "942e05b03fbafb17eda6a8486d0b69ce",
                "sha256": "d547245718238f4ead9b2a276069b55f7e47b3290e1258b43c657c73baf51cf5"
            },
            "downloads": -1,
            "filename": "ansible-docgenerator-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "942e05b03fbafb17eda6a8486d0b69ce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3017,
            "upload_time": "2015-10-30T08:30:16",
            "url": "https://files.pythonhosted.org/packages/ee/64/e2d192c3c10479e0ca2687c04dd69273562c7b486c2b7d707c8daf74436d/ansible-docgenerator-0.1.0.tar.gz"
        }
    ]
}