shuup.guide package

Submodules

shuup.guide.admin_module module

class shuup.guide.admin_module.GuideAdminModule

Bases: AdminModule

get_search_results(request, query)

Return type:

list[shuup.admin.base.SearchResult]

get_required_permissions()

Returns a list of required permissions for this module to be enabled :rtype: list[str]

shuup.guide.apps module

class shuup.guide.apps.AppConfig(*args, **kwargs)

Bases: AppConfig

name = 'shuup.guide'

verbose_name = 'Shuup Guide'

provides = {'admin_module': ['shuup.guide.admin_module:GuideAdminModule']}

See /provides for details about the provides variable.

shuup.guide.settings module

shuup.guide.settings.SHUUP_GUIDE_API_URL = 'https://readthedocs.org/api/v2/search/?project=shoop-guide&version=latest&'

ReadtheDocs API URL

URL for fetching search results via ReadtheDocs API.

shuup.guide.settings.SHUUP_GUIDE_LINK_URL = 'http://shuup-guide.readthedocs.io/en/latest/search.html?check_keywords=yes&area=default&'

ReadtheDocs link URL.

URL for manually linking search query link. Query parameters are added to end of URL when constructing link.

shuup.guide.settings.SHUUP_GUIDE_FETCH_RESULTS = True

Whether or not to fetch search results from ReadtheDocs.

If true, fetch results via the ReadtheDocs API, otherwise only display a link to the RTD search page.

shuup.guide.settings.SHUUP_GUIDE_TIMEOUT_LIMIT = 2

Timeout limit for fetching search results.

Time limit in seconds before a search result request should timeout, so as not to block other search results in case of slow response.

Module contents