{
    "info": {
        "author": "edX",
        "author_email": "oscm@edx.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Framework :: Django",
            "Framework :: Django :: 1.10",
            "Framework :: Django :: 1.11",
            "Framework :: Django :: 1.8",
            "Framework :: Django :: 1.9",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
            "Natural Language :: English",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "###########\nhelp-tokens\n###########\n\nDjango app for linking to help pages with short tokens.\n\n|pypi-badge| |travis-badge| |codecov-badge| |pyversions-badge|\n|license-badge|\n\n\nOverview\n********\n\nThere are various factors that affect what help page an application should link\nto:\n\n- There may be a number of relevant books\n\n- The version of the application might affect which book to display\n\n- The application's language might affect which book to display\n\nThis small Django app provides a means to use \"help tokens\" on the application\npages, and then use those tokens, and various other settings, to determine the\nactual URL to use.\n\n\nDocumentation\n*************\n\nHelp-tokens provides a context processor, and a redirection URL.  Configuration\nis in a number of settings.\n\nSettings\n========\n\nHelp-tokens reads these Django settings to create URLs:\n\n* HELP_TOKENS_INI_FILE: Path to a .ini file containing help token definitions.\n  The format of the ini file is described below.\n\n* HELP_TOKENS_BOOKS: a dictionary mapping book slugs to URLs.  For example::\n\n    HELP_TOKENS_BOOKS = {\n        'learner': 'http://edx.readthedocs.io/projects/learner-guide',\n        'course_author': 'http://edx.readthedocs.io/projects/running-a-course',\n    }\n\n* HELP_TOKENS_VERSION: a string used as part of the final URL, to choose the\n  correct version of the book.  For example, `\"latest\"`.\n\n* HELP_TOKENS_LANGUAGE_CODE: the language code to use as part of the book URL,\n  mapped through the [locales] section of the ini file.\n\nINI file format\n===============\n\nThe .ini file pointed to by HELP_TOKENS_INI_FILE contains the definitions of\nthe help tokens themselves.\n\nThe `[pages]` section defines the help tokens.  Each help token definition\nconsists of a book slug (defined in HELP_TOKENS_BOOKS), a colon, and a URL\npath.  The `default` token is used for missing tokens.  For example::\n\n    [pages]\n    default = learner:index.html\n    instructor = learner:SFD_instructor_dash_help.html\n    course = learner:index.html\n\n    cohortmanual = course_author:course_features/cohorts/cohort_config.html#assign-learners-to-cohorts-manually\n    cohortautomatic = course_author:course_features/cohorts/cohorts_overview.html#all-automated-assignment\n\nThe `[locales]` section defines language codes, used with\nHELP_TOKENS_LANGUAGE_CODE to determine the language portion of the URL::\n\n    [locales]\n    default = en\n    en = en\n    en_us = en\n\n\nContext processor\n=================\n\nThe context processor is `\"help_tokens.context_processor\"`.  It adds a function\n`get_online_help_info`.  Call it with a help token, and it will return a dict\nwith a `doc_url` entry, the help URL. You can use it like this in a template::\n\n    <a href=\"${get_online_help_info('visibility')['doc_url']}\">...</a>\n\nThis interface is a bit verbose, but is to maintain backward compatibility with\na previous implementation of this context processor.\n\n\nRedirection view\n================\n\nThe `help_tokens.urls` URLs define a view that redirects to a help URL. You can\ninclude it in your app::\n\n    # For redirecting to help pages.\n    url(r'^help_token/', include('help_tokens.urls')),\n\nThen visiting `help_token/foobar` will redirect to the URL defined by the\n\"foobar\" help token.\n\n\nLicense\n*******\n\nThe code in this repository is licensed under the AGPL 3.0 unless otherwise\nnoted.  Please see ``LICENSE.txt`` for details.\n\nHow To Contribute\n*****************\n\nContributions are very welcome.\n\nPlease read `How To Contribute <https://github.com/edx/edx-platform/blob/master/CONTRIBUTING.rst>`_ for details.\n\nEven though they were written with ``edx-platform`` in mind, the guidelines\nshould be followed for Open edX code in general.\n\nPR description template should be automatically applied if you are sending PR from GitHub interface; otherwise you\ncan find it it at `PULL_REQUEST_TEMPLATE.md <https://github.com/edx/help-tokens/blob/master/.github/PULL_REQUEST_TEMPLATE.md>`_\n\nIssue report template should be automatically applied if you are sending it from GitHub UI as well; otherwise you\ncan find it at `ISSUE_TEMPLATE.md <https://github.com/edx/help-tokens/blob/master/.github/ISSUE_TEMPLATE.md>`_\n\nReporting Security Issues\n*************************\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nGetting Help\n************\n\nHave a question about this repository, or about Open edX in general?  Please\nrefer to this `list of resources`_ if you need any assistance.\n\n.. _list of resources: https://open.edx.org/getting-help\n\n\n.. |pypi-badge| image:: https://img.shields.io/pypi/v/help-tokens.svg\n    :target: https://pypi.python.org/pypi/help-tokens/\n    :alt: PyPI\n\n.. |travis-badge| image:: https://travis-ci.org/edx/help-tokens.svg?branch=master\n    :target: https://travis-ci.org/edx/help-tokens\n    :alt: Travis\n\n.. |codecov-badge| image:: http://codecov.io/github/edx/help-tokens/coverage.svg?branch=master\n    :target: http://codecov.io/github/edx/help-tokens?branch=master\n    :alt: Codecov\n\n.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/help-tokens.svg\n    :target: https://pypi.python.org/pypi/help-tokens/\n    :alt: Supported Python versions\n\n.. |license-badge| image:: https://img.shields.io/github/license/edx/help-tokens.svg\n    :target: https://github.com/edx/help-tokens/blob/master/LICENSE.txt\n    :alt: License\n\n\n\nChange Log\n**********\n\n..\n   All enhancements and patches to help_tokens will be documented\n   in this file.  It adheres to the structure of http://keepachangelog.com/ ,\n   but in reStructuredText instead of Markdown (for ease of incorporation into\n   Sphinx documentation and the PyPI description).\n\n   This project adheres to Semantic Versioning (http://semver.org/).\n\n.. There should always be an \"Unreleased\" section for changes pending release.\n\n[1.0.3] - 2017-07-17\n====================\n\n* Updated tests to support Django 1.11\n* Updated dependency versions\n\n\n[1.0.2] - 2017-05-16\n====================\n\n* Fixed the README.\n\n\n[1.0.1] - 2017-05-15\n====================\n\n* First version on PyPI.\n\n\n[1.0.0] - 2017-05-03\n====================\n\n* First release.\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/edx/help-tokens",
        "keywords": "Django edx",
        "license": "AGPL 3.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "help-tokens",
        "package_url": "https://pypi.org/project/help-tokens/",
        "platform": "",
        "project_url": "https://pypi.org/project/help-tokens/",
        "project_urls": {
            "Homepage": "https://github.com/edx/help-tokens"
        },
        "release_url": "https://pypi.org/project/help-tokens/1.0.4/",
        "requires_dist": [
            "six",
            "Django",
            "Django (<2,>=1.8)"
        ],
        "requires_python": "",
        "summary": "Django app for linking to help pages with short tokens",
        "version": "1.0.4"
    },
    "last_serial": 5408840,
    "releases": {
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a9b4cc11e11420f572a9a3e57338a87a",
                    "sha256": "e5294b9663eb9cc68dcd6273ea323478389559ae4c86b82321d63dc8024dc1d8"
                },
                "downloads": -1,
                "filename": "help_tokens-1.0.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a9b4cc11e11420f572a9a3e57338a87a",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 10205,
                "upload_time": "2017-05-16T17:06:29",
                "url": "https://files.pythonhosted.org/packages/d4/ad/0414c3f57f41d652b19665e371d8b5072cdf4b20fdb6a5b13eb24daaa92e/help_tokens-1.0.1-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "96cae53346b12ae2a0feb73da1ccf271",
                    "sha256": "d98e9c747bbaaf5454e858bf2a82e91bc62a014ff16820cedbb024f8e90e492e"
                },
                "downloads": -1,
                "filename": "help-tokens-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "96cae53346b12ae2a0feb73da1ccf271",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20768,
                "upload_time": "2017-05-16T16:57:03",
                "url": "https://files.pythonhosted.org/packages/d4/38/a3094165f90f856743ffc8605ddc65d42de4a4b8c21af54609422093d105/help-tokens-1.0.1.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6ed09cb067671026478032cbf765c04b",
                    "sha256": "043afbb51e6fbc454b08849754cc4880bdba5aba64311f1955cd04d6881c6634"
                },
                "downloads": -1,
                "filename": "help_tokens-1.0.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6ed09cb067671026478032cbf765c04b",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 10241,
                "upload_time": "2017-05-16T20:41:40",
                "url": "https://files.pythonhosted.org/packages/2f/ac/bdef9a1d402d7d1eb7e07ee82d58797ca6d2e2863c60c08d085a32abb1e0/help_tokens-1.0.2-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b1183e7bcb064fa8050edd0d5d9965f2",
                    "sha256": "5aae39f1b6362084e33353f80a69cea30f748c596e2142101519ad3b3e21c897"
                },
                "downloads": -1,
                "filename": "help-tokens-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "b1183e7bcb064fa8050edd0d5d9965f2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20814,
                "upload_time": "2017-05-16T20:41:42",
                "url": "https://files.pythonhosted.org/packages/68/60/88e84a43bb643643c49b118507203526c519c138339a38a862df197be15d/help-tokens-1.0.2.tar.gz"
            }
        ],
        "1.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9050ce25c6ef16bebbbd55ed1f74b236",
                    "sha256": "b2abe46796995c39dfbe530180c266d9420324c38a099c4d4849ad01cb4d86a1"
                },
                "downloads": -1,
                "filename": "help_tokens-1.0.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "9050ce25c6ef16bebbbd55ed1f74b236",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 10335,
                "upload_time": "2017-07-05T19:14:48",
                "url": "https://files.pythonhosted.org/packages/d9/1e/8004a00b7199666bc907557623d938bf601bbfe8b4fc6342fc6de06ea8e7/help_tokens-1.0.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "24982e5e76c9c60f174b510b55e7653b",
                    "sha256": "e566d50ebd17e49a14924ea3628ef66e8f4145c6f9aeaa817fcccabcc540fef1"
                },
                "downloads": -1,
                "filename": "help-tokens-1.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "24982e5e76c9c60f174b510b55e7653b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20925,
                "upload_time": "2017-07-05T19:14:49",
                "url": "https://files.pythonhosted.org/packages/5a/c5/bba80872aa03c0b53f0ca44ec9c203e1a44d9319966f145c1888eed4fc8d/help-tokens-1.0.3.tar.gz"
            }
        ],
        "1.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d3ae9af2afc50f1bdffcf27b99d2cc46",
                    "sha256": "95ef6de445b27d80f70664c74d396d4563a91780509373903f719519e3306934"
                },
                "downloads": -1,
                "filename": "help_tokens-1.0.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d3ae9af2afc50f1bdffcf27b99d2cc46",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 19376,
                "upload_time": "2019-06-17T06:48:42",
                "url": "https://files.pythonhosted.org/packages/fe/e6/130eccc7c4ebb4d16cdad07456ffbda16e39f2b01ab3d2fb16dd47b28c4f/help_tokens-1.0.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "657dbbe00bc1d70bcfb90fe28dd9d0f0",
                    "sha256": "8f73014d076d57e35891e17f45154903859b201f7ced1960bb3c34fb9fc280c9"
                },
                "downloads": -1,
                "filename": "help-tokens-1.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "657dbbe00bc1d70bcfb90fe28dd9d0f0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 18773,
                "upload_time": "2019-06-17T06:48:44",
                "url": "https://files.pythonhosted.org/packages/2f/2b/a1b732f4cad3ea707cd6fece31dbebdb778b56bed220e3f25c1821f46364/help-tokens-1.0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "d3ae9af2afc50f1bdffcf27b99d2cc46",
                "sha256": "95ef6de445b27d80f70664c74d396d4563a91780509373903f719519e3306934"
            },
            "downloads": -1,
            "filename": "help_tokens-1.0.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d3ae9af2afc50f1bdffcf27b99d2cc46",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 19376,
            "upload_time": "2019-06-17T06:48:42",
            "url": "https://files.pythonhosted.org/packages/fe/e6/130eccc7c4ebb4d16cdad07456ffbda16e39f2b01ab3d2fb16dd47b28c4f/help_tokens-1.0.4-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "657dbbe00bc1d70bcfb90fe28dd9d0f0",
                "sha256": "8f73014d076d57e35891e17f45154903859b201f7ced1960bb3c34fb9fc280c9"
            },
            "downloads": -1,
            "filename": "help-tokens-1.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "657dbbe00bc1d70bcfb90fe28dd9d0f0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 18773,
            "upload_time": "2019-06-17T06:48:44",
            "url": "https://files.pythonhosted.org/packages/2f/2b/a1b732f4cad3ea707cd6fece31dbebdb778b56bed220e3f25c1821f46364/help-tokens-1.0.4.tar.gz"
        }
    ]
}