{"id":27042,"library":"help-tokens","title":"help-tokens","description":"Django app for linking to help pages with short tokens. Current version 4.0.0 (released Feb 2024). Maintained as part of the Open edX ecosystem; irregular release cadence.","status":"active","version":"4.0.0","language":"python","source_language":"en","source_url":"https://github.com/openedx/help-tokens","tags":["django","help","tokens","openedx"],"install":[{"cmd":"pip install help-tokens","lang":"bash","label":"Latest"}],"dependencies":[],"imports":[{"note":"","wrong":"","symbol":"HelpTokenMiddleware","correct":"from help_tokens.middleware import HelpTokenMiddleware"},{"note":"","wrong":"","symbol":"HelpUrl","correct":"from help_tokens.models import HelpUrl"},{"note":"get_help_url is in help_tokens.core, not top-level","wrong":"from help_tokens import get_help_url","symbol":"get_help_url","correct":"from help_tokens.core import get_help_url"},{"note":"old imports from 'app_config' were renamed to 'apps' in v2.0.0","wrong":"from help_tokens.app_config import HelpTokensAppConfig","symbol":"HelpTokensAppConfig","correct":"from help_tokens.apps import HelpTokensAppConfig"}],"quickstart":{"code":"# settings.py\nINSTALLED_APPS = [\n    ...\n    'help_tokens',\n]\n\nMIDDLEWARE = [\n    ...\n    'help_tokens.middleware.HelpTokenMiddleware',\n]\n\nHELP_TOKENS_BASE_URL = os.environ.get('HELP_TOKENS_BASE_URL', 'http://example.com/help/')\nHELP_TOKENS = {\n    'student-dashboard': 'student/dashboard/',\n}\n","lang":"python","description":"Add help_tokens to INSTALLED_APPS, include the middleware, and define HELP_TOKENS mapping."},"warnings":[{"fix":"Use Python 3.12+ or install help-tokens==3.2.0.","message":"v4.0.0 dropped support for Python 3.11. Python 3.11 users must pin to <4.0.0.","severity":"breaking","affected_versions":">=4.0.0"},{"fix":"Upgrade Python to 3.6+.","message":"v2.0.0 dropped Python 3.5 support. Ensure your Python version is >=3.6.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Use 'from help_tokens.core import get_help_url'.","message":"The import 'from help_tokens import get_help_url' was deprecated in v2.0.0 and removed in v4.0.0.","severity":"deprecated","affected_versions":">=4.0.0"},{"fix":"Ensure middleware ordering: SessionMiddleware, AuthenticationMiddleware, then HelpTokenMiddleware.","message":"Middleware must be placed after SessionMiddleware and AuthenticationMiddleware to access user context.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use: from help_tokens.core import get_help_url","cause":"get_help_url is not exposed at the package level; it's in help_tokens.core.","error":"ImportError: cannot import name 'get_help_url' from 'help_tokens'"},{"fix":"Use: from help_tokens.apps import HelpTokensAppConfig","cause":"AppConfig class moved from help_tokens.app_config to help_tokens.apps in v2.0.0.","error":"ModuleNotFoundError: No module named 'help_tokens.app_config'"},{"fix":"Add to settings: HELP_TOKENS_BASE_URL = 'https://your-help-base-url.com/'","cause":"HELP_TOKENS_BASE_URL setting is required but not defined.","error":"KeyError: 'HELP_TOKENS_BASE_URL'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}