{
    "info": {
        "author": "Pebble",
        "author_email": "scott.walton@mypebble.co.uk",
        "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": "Madcap Flare Integration\n========================\n\nSimple integration tools to link to embedded Madcap Flare help\n\nInstallation\n------------\n\nInstall the Madcap Flare integration from PyPi:\n\n::\n\n    pip install django-madcap-flare\n\nand add it to your settings.py:\n\n.. code:: python\n\n    INSTALLED_APPS = [\n        ...\n        'madcap_flare',\n        ...\n    ]\n\nYou will also need to configure the ```MADCAP_FLARE_ROOT`` and\n``MADCAP_FLARE_TAGS`` <#configuring>`__\n\nUsage\n-----\n\nYou can convert Madcap Flare header files into a Python dict with the\n``get_help_mapping`` command:\n\n::\n\n    python manage.py get_help_mapping path_to_file.h\n\nThis will output a dict on the command line that you can copy into your\nsettings.py file.\n\nConfiguring\n~~~~~~~~~~~\n\nTo setup your template tags, take the output of ``get_help_mapping`` and\nset it to the ``MADCAP_FLARE_TAGS`` in settings.py:\n\n.. code:: python\n\n    MADCAP_FLARE_TAGS = {\n      'my-help-topic': '1000',\n      'other-help-topic': '2000',\n    }\n\n    MADCAP_FLARE_ROOT = 'https://www.example.com/help_topics/'\n\nThe ``MADCAP_FLARE_ROOT`` setting tells Django what to use for your host\nname and default path.\n\nView Mixin\n~~~~~~~~~~\n\nTo inject your information into your templates, you can use the view\nmixin for Madcap Flare:\n\n.. code:: python\n\n    from django.views.generic import ListView\n\n    from madcap_flare.views import MadcapFlareMixin\n\n    from myproject.myapp.models import MyModel\n\n\n    class MyListView(MadcapFlareMixin, ListView):\n        \"\"\"Sample list view.\n        \"\"\"\n\n        help_key = 'my-help-topic'\n        queryset = MyModel.objects.all()\n\nThe MadcapFlareMixin injects the ``help_key`` object into your template\ncontext.\n\nTemplate Tag\n~~~~~~~~~~~~\n\nThe ``madcap_flare_help`` template tag outputs a Madcap Flare URL that\ncan be linked from your templates:\n\n.. code:: html\n\n    {% load madcap_flare_tags %}\n\n    <p>To get more help on this feature, see our\n      <a href=\"{% madcap_flare_help %}\">documentation</a>\n    </p>\n\nWith the ``help_key`` set above, this will output:\n\n.. code:: html\n\n    <p>To get more help on this feature, see our\n      <a href=\"https://www.example.com/help_topics/Default.htm#cshid=1000\">documentation</a>\n    </p>\n\nDeveloping\n----------\n\nTo test the integration just run:\n\n.. code:: bash\n\n    virtualenv venv\n    . venv/bin/activate\n    pip install -r requirements.txt\n    python setup.py develop\n    python tests/manage.py test\n\nWriting Docs for PyPI\n~~~~~~~~~~~~~~~~~~~~~\n\nTo convert the docs to RST for PyPI:\n\n.. code:: bash\n\n    pandoc --from=markdown --to=rst --output=README.txt README.md",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/mypebble/django-madcap-flare",
        "keywords": "django madcap flare web development",
        "license": "MIT",
        "maintainer": null,
        "maintainer_email": null,
        "name": "django-madcap-flare",
        "package_url": "https://pypi.org/project/django-madcap-flare/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/django-madcap-flare/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "https://github.com/mypebble/django-madcap-flare"
        },
        "release_url": "https://pypi.org/project/django-madcap-flare/0.0.3/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Integrate Madcap Flare docs into your Django project",
        "version": "0.0.3"
    },
    "last_serial": 2300055,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fa91e24f1a0c242e673363d9e9b762e8",
                    "sha256": "80adc95dd4a64ab739254b69ef3abe82fcc4ef6c16775171e95883632d0ada86"
                },
                "downloads": -1,
                "filename": "django-madcap-flare-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fa91e24f1a0c242e673363d9e9b762e8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3932,
                "upload_time": "2016-08-24T09:00:56",
                "url": "https://files.pythonhosted.org/packages/f6/e4/eaa896661ba456ca2b9a374d2ecc85ee44ffa1697559e656bcb4225466b4/django-madcap-flare-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "986cfa3e0a139efe4ea347bf22ca55d9",
                    "sha256": "423b671d64f4c7c864ff1ceb2ced9b399cc9d0d2f29ef661a086924328b37c43"
                },
                "downloads": -1,
                "filename": "django-madcap-flare-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "986cfa3e0a139efe4ea347bf22ca55d9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5211,
                "upload_time": "2016-08-24T09:04:07",
                "url": "https://files.pythonhosted.org/packages/9a/02/7987fab7847e9f117e9bd03c9c84c1f695c476f4953fff0741a9cf72a19f/django-madcap-flare-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c55cd4add4c46b77807e875bc9abc72",
                    "sha256": "4a8b43870a42c4f6cc2a6c073dc3f977e4b22ed6d9db487e2db3360e880032c4"
                },
                "downloads": -1,
                "filename": "django-madcap-flare-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "6c55cd4add4c46b77807e875bc9abc72",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5222,
                "upload_time": "2016-08-24T09:09:27",
                "url": "https://files.pythonhosted.org/packages/04/73/696944ea83147b25a26e2ebf9e4a75372bbc0d06c43f97c269e15ff7028b/django-madcap-flare-0.0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "6c55cd4add4c46b77807e875bc9abc72",
                "sha256": "4a8b43870a42c4f6cc2a6c073dc3f977e4b22ed6d9db487e2db3360e880032c4"
            },
            "downloads": -1,
            "filename": "django-madcap-flare-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "6c55cd4add4c46b77807e875bc9abc72",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5222,
            "upload_time": "2016-08-24T09:09:27",
            "url": "https://files.pythonhosted.org/packages/04/73/696944ea83147b25a26e2ebf9e4a75372bbc0d06c43f97c269e15ff7028b/django-madcap-flare-0.0.3.tar.gz"
        }
    ]
}